DocumentAttributeValue (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.DocumentAttributeValue

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentAttributeValue
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The value of a custom document attribute. You can only provide one value for a custom attribute.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentAttributeValue()

Constructors
Constructor and Description
`DocumentAttributeValue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentAttributeValue`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getDateValue()` A date expressed as an ISO 8601 string.
`Long`	`getLongValue()` A long integer value.
`List<String>`	`getStringListValue()` A list of strings.
`String`	`getStringValue()` A string, such as "department".
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDateValue(Date dateValue)` A date expressed as an ISO 8601 string.
`void`	`setLongValue(Long longValue)` A long integer value.
`void`	`setStringListValue(Collection<String> stringListValue)` A list of strings.
`void`	`setStringValue(String stringValue)` A string, such as "department".
`String`	`toString()` Returns a string representation of this object.
`DocumentAttributeValue`	`withDateValue(Date dateValue)` A date expressed as an ISO 8601 string.
`DocumentAttributeValue`	`withLongValue(Long longValue)` A long integer value.
`DocumentAttributeValue`	`withStringListValue(Collection<String> stringListValue)` A list of strings.
`DocumentAttributeValue`	`withStringListValue(String... stringListValue)` A list of strings.
`DocumentAttributeValue`	`withStringValue(String stringValue)` A string, such as "department".

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentAttributeValue
```
public DocumentAttributeValue()
```
- Method Detail
  - setStringValue
```
public void setStringValue(String stringValue)
```
    A string, such as "department".
    
    Parameters:
    
    stringValue - A string, such as "department".
  - getStringValue
```
public String getStringValue()
```
    A string, such as "department".
    
    Returns:
    
    A string, such as "department".
  - withStringValue
```
public DocumentAttributeValue withStringValue(String stringValue)
```
    A string, such as "department".
    
    Parameters:
    
    stringValue - A string, such as "department".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStringListValue
```
public List<String> getStringListValue()
```
    A list of strings.
    
    Returns:
    
    A list of strings.
  - setStringListValue
```
public void setStringListValue(Collection<String> stringListValue)
```
    A list of strings.
    
    Parameters:
    
    stringListValue - A list of strings.
  - withStringListValue
```
public DocumentAttributeValue withStringListValue(String... stringListValue)
```
    A list of strings.
    
    NOTE: This method appends the values to the existing list (if any). Use setStringListValue(java.util.Collection) or withStringListValue(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    stringListValue - A list of strings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStringListValue
```
public DocumentAttributeValue withStringListValue(Collection<String> stringListValue)
```
    A list of strings.
    
    Parameters:
    
    stringListValue - A list of strings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLongValue
```
public void setLongValue(Long longValue)
```
    A long integer value.
    
    Parameters:
    
    longValue - A long integer value.
  - getLongValue
```
public Long getLongValue()
```
    A long integer value.
    
    Returns:
    
    A long integer value.
  - withLongValue
```
public DocumentAttributeValue withLongValue(Long longValue)
```
    A long integer value.
    
    Parameters:
    
    longValue - A long integer value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateValue
```
public void setDateValue(Date dateValue)
```
    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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
    
    Parameters:
    
    dateValue - 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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
  - getDateValue
```
public Date getDateValue()
```
    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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
    
    Returns:
    
    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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
  - withDateValue
```
public DocumentAttributeValue withDateValue(Date dateValue)
```
    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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
    
    Parameters:
    
    dateValue - 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, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentAttributeValue clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DocumentAttributeValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentAttributeValue

Method Detail

setStringValue

getStringValue

withStringValue

getStringListValue

setStringListValue

withStringListValue

withStringListValue

setLongValue

getLongValue

withLongValue

setDateValue

getDateValue

withDateValue

toString

equals

hashCode

clone

marshall