software.amazon.awssdk.services.clouddirectory.model

Class CreateFacetRequest

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.CreateFacetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFacetRequest.Builder,CreateFacetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFacetRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<FacetAttribute>	attributes() The attributes that are associated with the Facet.
static CreateFacetRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FacetStyle	facetStyle() There are two different styles that you can define on any given facet, Static and Dynamic.
String	facetStyleAsString() There are two different styles that you can define on any given facet, Static and Dynamic.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	name() The name of the Facet, which is unique for a given schema.
ObjectType	objectType() Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
String	objectTypeAsString() Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
String	schemaArn() The schema ARN in which the new Facet will be created.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFacetRequest.Builder>	serializableBuilderClass()
CreateFacetRequest.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

schemaArn

public final String schemaArn()

The schema ARN in which the new Facet will be created. For more information, see arns.

Returns:

The schema ARN in which the new Facet will be created. For more information, see arns.

name

public final String name()

The name of the Facet, which is unique for a given schema.

Returns:

The name of the Facet, which is unique for a given schema.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes 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.

attributes

public final List<FacetAttribute> attributes()

The attributes that are associated with the Facet.

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

Returns:

The attributes that are associated with the Facet.

objectType

public final ObjectType objectType()

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

• Node: Can have multiple children but one parent.

• Leaf node: Cannot have children but can have multiple parents.

• Policy: Allows you to store a policy document and policy type. For more information, see Policies.

• Index: Can be created with the Index API.

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

Returns:

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

• Node: Can have multiple children but one parent.

• Leaf node: Cannot have children but can have multiple parents.

• Policy: Allows you to store a policy document and policy type. For more information, see Policies.

• Index: Can be created with the Index API.

See Also:

ObjectType

objectTypeAsString

public final String objectTypeAsString()

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

• Node: Can have multiple children but one parent.

• Leaf node: Cannot have children but can have multiple parents.

• Policy: Allows you to store a policy document and policy type. For more information, see Policies.

• Index: Can be created with the Index API.

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

Returns:

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

• Node: Can have multiple children but one parent.

• Leaf node: Cannot have children but can have multiple parents.

• Policy: Allows you to store a policy document and policy type. For more information, see Policies.

• Index: Can be created with the Index API.

See Also:

ObjectType

facetStyle

public final FacetStyle facetStyle()

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

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

Returns:

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

See Also:

FacetStyle

facetStyleAsString

public final String facetStyleAsString()

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

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

Returns:

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

See Also:

FacetStyle

toBuilder

public CreateFacetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFacetRequest.Builder,CreateFacetRequest>

Specified by:

toBuilder in class CloudDirectoryRequest

builder

public static CreateFacetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFacetRequest.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