Class DescribeOrganizationResponse

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

  • Method Details

    • organizationId

      public final String organizationId()

      The identifier of an organization.

      Returns:
      The identifier of an organization.

    • alias

      public final String alias()

      The alias for an organization.

      Returns:
      The alias for an organization.

    • state

      public final String state()

      The state of an organization.

      Returns:
      The state of an organization.

    • directoryId

      public final String directoryId()

      The identifier for the directory associated with an WorkMail organization.

      Returns:
      The identifier for the directory associated with an WorkMail organization.

    • directoryType

      public final String directoryType()

      The type of directory associated with the WorkMail organization.

      Returns:
      The type of directory associated with the WorkMail organization.

    • defaultMailDomain

      public final String defaultMailDomain()

      The default mail domain associated with the organization.

      Returns:
      The default mail domain associated with the organization.

    • completedDate

      public final Instant completedDate()

      The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

      Returns:
      The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

    • errorMessage

      public final String errorMessage()

      (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

      Returns:
      (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the organization.

      Returns:
      The Amazon Resource Name (ARN) of the organization.

    • migrationAdmin

      public final String migrationAdmin()

      The user ID of the migration admin if migration is enabled for the organization.

      Returns:
      The user ID of the migration admin if migration is enabled for the organization.

    • interoperabilityEnabled

      public final Boolean interoperabilityEnabled()

      Indicates if interoperability is enabled for this organization.

      Returns:
      Indicates if interoperability is enabled for this organization.

    • toBuilder

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

    • builder

      public static DescribeOrganizationResponse.Builder builder()

    • serializableBuilderClass

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