Class GetDesignationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.datazone.model.DataZoneResponse
software.amazon.awssdk.services.datazone.model.GetDesignationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDesignationResponse.Builder,GetDesignationResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDesignationResponse extends DataZoneResponse implements ToCopyableBuilder<GetDesignationResponse.Builder,GetDesignationResponse>

A designation defines a named role with a Cedar permit policy that controls what actions members holding this designation can perform within a project.

  • Method Details

    • domainId

      public final String domainId()

      The identifier of the Amazon DataZone domain that contains the designation.

      Returns:
      The identifier of the Amazon DataZone domain that contains the designation.

    • id

      public final String id()

      The unique ID of the designation.

      Returns:
      The unique ID of the designation.

    • name

      public final String name()

      The name of the designation. The name is unique within the domain.

      Returns:
      The name of the designation. The name is unique within the domain.

    • description

      public final String description()

      A human-readable description of the designation and its intended use.

      Returns:
      A human-readable description of the designation and its intended use.

    • designationType

      public final DesignationType designationType()

      The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.

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

      Returns:
      The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.
      See Also:

    • designationTypeAsString

      public final String designationTypeAsString()

      The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.

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

      Returns:
      The classification of this designation. MANAGED designations are system-defined and cannot be modified or deleted.
      See Also:

    • policy

      public final String policy()

      The Cedar permit policy that governs what actions holders of this designation are allowed to perform.

      Returns:
      The Cedar permit policy that governs what actions holders of this designation are allowed to perform.

    • deletionProtection

      public final Boolean deletionProtection()

      Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via UpdateDesignation.

      Returns:
      Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via UpdateDesignation.

    • createdBy

      public final String createdBy()

      The identifier of the Amazon DataZone user who created the designation.

      Returns:
      The identifier of the Amazon DataZone user who created the designation.

    • createdAt

      public final Instant createdAt()

      The date and time when the designation was created.

      Returns:
      The date and time when the designation was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when the designation was last updated.

      Returns:
      The date and time when the designation was last updated.

    • toBuilder

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

    • builder

      public static GetDesignationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.