Class DomainInfo

java.lang.Object
software.amazon.awssdk.services.swf.model.DomainInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DomainInfo.Builder,DomainInfo>
@Generated("software.amazon.awssdk:codegen") public final class DomainInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DomainInfo.Builder,DomainInfo>

Contains general information about a domain.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the domain. This name is unique within the account.

      Returns:
      The name of the domain. This name is unique within the account.

    • status

      public final RegistrationStatus status()

      The status of the domain:

      • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

      • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

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

      Returns:
      The status of the domain:

      • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

      • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the domain:

      • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

      • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

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

      Returns:
      The status of the domain:

      • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

      • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

      See Also:

    • description

      public final String description()

      The description of the domain provided through RegisterDomain.

      Returns:
      The description of the domain provided through RegisterDomain.

    • arn

      public final String arn()

      The ARN of the domain.

      Returns:
      The ARN of the domain.

    • toBuilder

      public DomainInfo.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<DomainInfo.Builder,DomainInfo>
      Returns:
      a builder for type T

    • builder

      public static DomainInfo.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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