Class Domain

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

Detailed information about a domain.

See Also:

  • Method Details

    • domainId

      public final String domainId()

      The unique ID of the domain.

      Returns:
      The unique ID of the domain.

    • domainArn

      public final String domainArn()

      The Amazon Resource Name (ARN) of the domain.

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

    • name

      public final String name()

      A name that identifies the domain.

      Returns:
      A name that identifies the domain.

    • identityProviders

      public final List<IdentityProvider> identityProviders()

      The identity providers configured for the domain.

      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 hasIdentityProviders() method.

      Returns:
      The identity providers configured for the domain.

    • hasIdentityProviders

      public final boolean hasIdentityProviders()
      For responses, this returns true if the service returned a value for the IdentityProviders 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.

    • identityProvidersAsStrings

      public final List<String> identityProvidersAsStrings()

      The identity providers configured for the domain.

      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 hasIdentityProviders() method.

      Returns:
      The identity providers configured for the domain.

    • identityProviderConfiguration

      public final IdentityProviderConfiguration identityProviderConfiguration()

      Identity provider configuration for the domain.

      Returns:
      Identity provider configuration for the domain.

    • domainEndpointUrl

      public final String domainEndpointUrl()

      The HTTPS endpoint URL for accessing the domain.

      Returns:
      The HTTPS endpoint URL for accessing the domain.

    • hasCustomEndpointUrls

      public final boolean hasCustomEndpointUrls()
      For responses, this returns true if the service returned a value for the CustomEndpointUrls 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.

    • customEndpointUrls

      public final List<String> customEndpointUrls()

      Additional endpoint URLs derived from the domain name.

      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 hasCustomEndpointUrls() method.

      Returns:
      Additional endpoint URLs derived from the domain name.

    • identityCenterApplicationArn

      public final String identityCenterApplicationArn()

      The ARN of the Identity Center application. Absent for IAM-only domains.

      Returns:
      The ARN of the Identity Center application. Absent for IAM-only domains.

    • region

      public final String region()

      The Region where this domain was created.

      Returns:
      The Region where this domain was created.

    • createdAt

      public final Instant createdAt()

      The timestamp when the domain was created.

      Returns:
      The timestamp when the domain was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the domain was last updated.

      Returns:
      The timestamp when the domain was last updated.

    • status

      public final DomainStatus status()

      Current status of the domain.

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

      Returns:
      Current status of the domain.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the domain.

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

      Returns:
      Current status of the domain.
      See Also:

    • toBuilder

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

    • builder

      public static Domain.Builder builder()

    • serializableBuilderClass

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