Class RegionDescription

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

The replicated Region information for a directory.

See Also:

  • Method Details

    • directoryId

      public final String directoryId()

      The identifier of the directory.

      Returns:
      The identifier of the directory.

    • regionName

      public final String regionName()

      The name of the Region. For example, us-east-1.

      Returns:
      The name of the Region. For example, us-east-1.

    • regionType

      public final RegionType regionType()

      Specifies whether the Region is the primary Region or an additional Region.

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

      Returns:
      Specifies whether the Region is the primary Region or an additional Region.
      See Also:

    • regionTypeAsString

      public final String regionTypeAsString()

      Specifies whether the Region is the primary Region or an additional Region.

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

      Returns:
      Specifies whether the Region is the primary Region or an additional Region.
      See Also:

    • status

      public final DirectoryStage status()

      The status of the replication process for the specified Region.

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

      Returns:
      The status of the replication process for the specified Region.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the replication process for the specified Region.

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

      Returns:
      The status of the replication process for the specified Region.
      See Also:

    • vpcSettings

      public final DirectoryVpcSettings vpcSettings()
      Returns the value of the VpcSettings property for this object.
      Returns:
      The value of the VpcSettings property for this object.

    • desiredNumberOfDomainControllers

      public final Integer desiredNumberOfDomainControllers()

      The desired number of domain controllers in the specified Region for the specified directory.

      Returns:
      The desired number of domain controllers in the specified Region for the specified directory.

    • launchTime

      public final Instant launchTime()

      Specifies when the Region replication began.

      Returns:
      Specifies when the Region replication began.

    • statusLastUpdatedDateTime

      public final Instant statusLastUpdatedDateTime()

      The date and time that the Region status was last updated.

      Returns:
      The date and time that the Region status was last updated.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time that the Region description was last updated.

      Returns:
      The date and time that the Region description was last updated.

    • toBuilder

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

    • builder

      public static RegionDescription.Builder builder()

    • serializableBuilderClass

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