Class InstanceSummary

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

Information about the instance.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the instance.

      Returns:
      The identifier of the instance.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the instance.

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

    • identityManagementType

      public final DirectoryType identityManagementType()

      The identity management type of the instance.

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

      Returns:
      The identity management type of the instance.
      See Also:

    • identityManagementTypeAsString

      public final String identityManagementTypeAsString()

      The identity management type of the instance.

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

      Returns:
      The identity management type of the instance.
      See Also:

    • instanceAlias

      public final String instanceAlias()

      The alias of the instance.

      Returns:
      The alias of the instance.

    • createdTime

      public final Instant createdTime()

      When the instance was created.

      Returns:
      When the instance was created.

    • serviceRole

      public final String serviceRole()

      The service role of the instance.

      Returns:
      The service role of the instance.

    • instanceStatus

      public final InstanceStatus instanceStatus()

      The state of the instance.

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

      Returns:
      The state of the instance.
      See Also:

    • instanceStatusAsString

      public final String instanceStatusAsString()

      The state of the instance.

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

      Returns:
      The state of the instance.
      See Also:

    • inboundCallsEnabled

      public final Boolean inboundCallsEnabled()

      Whether inbound calls are enabled.

      Returns:
      Whether inbound calls are enabled.

    • outboundCallsEnabled

      public final Boolean outboundCallsEnabled()

      Whether outbound calls are enabled.

      Returns:
      Whether outbound calls are enabled.

    • instanceAccessUrl

      public final String instanceAccessUrl()

      This URL allows contact center users to access the Amazon Connect admin website.

      Returns:
      This URL allows contact center users to access the Amazon Connect admin website.

    • toBuilder

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

    • builder

      public static InstanceSummary.Builder builder()

    • serializableBuilderClass

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