Class: Aws::Kendra::Types::DocumentAttributeValue

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass DocumentAttributeValue data as a hash:

{
  string_value: "DocumentAttributeStringValue",
  string_list_value: ["String"],
  long_value: 1,
  date_value: Time.now,
}

The value of a custom document attribute. You can only provide one value for a custom attribute.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#date_valueTime

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Returns:

  • (Time)


5245
5246
5247
5248
5249
5250
5251
5252
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5245

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value)
  SENSITIVE = []
  include Aws::Structure
end

#long_valueInteger

A long integer value.

Returns:

  • (Integer)


5245
5246
5247
5248
5249
5250
5251
5252
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5245

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value)
  SENSITIVE = []
  include Aws::Structure
end

#string_list_valueArray<String>

A list of strings.

Returns:

  • (Array<String>)


5245
5246
5247
5248
5249
5250
5251
5252
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5245

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value)
  SENSITIVE = []
  include Aws::Structure
end

#string_valueString

A string, such as "department".

Returns:

  • (String)


5245
5246
5247
5248
5249
5250
5251
5252
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5245

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value)
  SENSITIVE = []
  include Aws::Structure
end