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

Class CreateFacetRequest

    • 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

      • 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