Class AgentStatus

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

Contains information about an agent status.

See Also:

  • Method Details

    • agentStatusARN

      public final String agentStatusARN()

      The Amazon Resource Name (ARN) of the agent status.

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

    • agentStatusId

      public final String agentStatusId()

      The identifier of the agent status.

      Returns:
      The identifier of the agent status.

    • name

      public final String name()

      The name of the agent status.

      Returns:
      The name of the agent status.

    • description

      public final String description()

      The description of the agent status.

      Returns:
      The description of the agent status.

    • type

      public final AgentStatusType type()

      The type of agent status.

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

      Returns:
      The type of agent status.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of agent status.

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

      Returns:
      The type of agent status.
      See Also:

    • displayOrder

      public final Integer displayOrder()

      The display order of the agent status.

      Returns:
      The display order of the agent status.

    • state

      public final AgentStatusState state()

      The state of the agent status.

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

      Returns:
      The state of the agent status.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the agent status.

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

      Returns:
      The state of the agent status.
      See Also:

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

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

      Returns:
      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when this resource was last modified.

      Returns:
      The timestamp when this resource was last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The Amazon Web Services Region where this resource was last modified.

      Returns:
      The Amazon Web Services Region where this resource was last modified.

    • toBuilder

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

    • builder

      public static AgentStatus.Builder builder()

    • serializableBuilderClass

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