Package software.amazon.awssdk.services.clouddirectory.model

Class GetObjectAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest

software.amazon.awssdk.services.clouddirectory.model.GetObjectAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetObjectAttributesRequest
extends CloudDirectoryRequest
implements ToCopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetObjectAttributesRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	attributeNames()	List of attribute names whose values will be retrieved.
static GetObjectAttributesRequest.Builder	builder()
ConsistencyLevel	consistencyLevel()	The consistency level at which to retrieve the attributes on an object.
String	consistencyLevelAsString()	The consistency level at which to retrieve the attributes on an object.
String	directoryArn()	The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeNames()	For responses, this returns true if the service returned a value for the AttributeNames property.
int	hashCode()
ObjectReference	objectReference()	Reference that identifies the object whose attributes will be retrieved.
SchemaFacet	schemaFacet()	Identifier for the facet whose attributes will be retrieved.
List<SdkField<?>>	sdkFields()
static Class<? extends GetObjectAttributesRequest.Builder>	serializableBuilderClass()
GetObjectAttributesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

directoryArn

public final String directoryArn()

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.

Returns:

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.

objectReference

public final ObjectReference objectReference()

Reference that identifies the object whose attributes will be retrieved.

Returns:

Reference that identifies the object whose attributes will be retrieved.

consistencyLevel

public final ConsistencyLevel consistencyLevel()

The consistency level at which to retrieve the attributes on an object.

If the service returns an enum value that is not available in the current SDK version, consistencyLevel will return ConsistencyLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consistencyLevelAsString().

Returns:

The consistency level at which to retrieve the attributes on an object.

See Also:

ConsistencyLevel

consistencyLevelAsString

public final String consistencyLevelAsString()

The consistency level at which to retrieve the attributes on an object.

If the service returns an enum value that is not available in the current SDK version, consistencyLevel will return ConsistencyLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consistencyLevelAsString().

Returns:

The consistency level at which to retrieve the attributes on an object.

See Also:

ConsistencyLevel

schemaFacet

public final SchemaFacet schemaFacet()

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

Returns:

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

hasAttributeNames

public final boolean hasAttributeNames()

For responses, this returns true if the service returned a value for the AttributeNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

attributeNames

public final List<String> attributeNames()

List of attribute names whose values will be retrieved.

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 hasAttributeNames() method.

Returns:

List of attribute names whose values will be retrieved.

toBuilder

public GetObjectAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>

Specified by:

toBuilder in class CloudDirectoryRequest

builder

public static GetObjectAttributesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetObjectAttributesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo