Class BatchCreateIndex
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BatchCreateIndex.Builder,
BatchCreateIndex>
Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The batch reference name.static BatchCreateIndex.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OrderedIndexedAttributeList property.final Boolean
isUnique()
Indicates whether the attribute that is being indexed has unique values or not.final String
linkName()
The name of the link between the parent object and the index object.final List
<AttributeKey> Specifies the attributes that should be indexed on.final ObjectReference
A reference to the parent object that contains the index object.static Class
<? extends BatchCreateIndex.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasOrderedIndexedAttributeList
public final boolean hasOrderedIndexedAttributeList()For responses, this returns true if the service returned a value for the OrderedIndexedAttributeList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
orderedIndexedAttributeList
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOrderedIndexedAttributeList()
method.- Returns:
- Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
-
isUnique
Indicates whether the attribute that is being indexed has unique values or not.
- Returns:
- Indicates whether the attribute that is being indexed has unique values or not.
-
parentReference
A reference to the parent object that contains the index object.
- Returns:
- A reference to the parent object that contains the index object.
-
linkName
The name of the link between the parent object and the index object.
- Returns:
- The name of the link between the parent object and the index object.
-
batchReferenceName
The batch reference name. See Transaction Support for more information.
- Returns:
- The batch reference name. See Transaction Support for more information.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BatchCreateIndex.Builder,
BatchCreateIndex> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-