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("software.amazon.awssdk:codegen") public final class CreateFacetRequest extends CloudDirectoryRequest implements ToCopyableBuilder<CreateFacetRequest.Builder,CreateFacetRequest>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public CreateFacetRequest.Builder 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 interface ToCopyableBuilder<CreateFacetRequest.Builder,CreateFacetRequest>
      Specified by:
      toBuilder in class CloudDirectoryRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.