Package software.amazon.awssdk.services.chimesdkvoice.model

Class ProxySession

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

The proxy session for an Amazon Chime SDK Voice Connector.

See Also:

  • Method Details

    • voiceConnectorId

      public final String voiceConnectorId()

      The Voice Connector ID.

      Returns:
      The Voice Connector ID.

    • proxySessionId

      public final String proxySessionId()

      The proxy session ID.

      Returns:
      The proxy session ID.

    • name

      public final String name()

      The proxy session name.

      Returns:
      The proxy session name.

    • status

      public final ProxySessionStatus status()

      The proxy session status.

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

      Returns:
      The proxy session status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The proxy session status.

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

      Returns:
      The proxy session status.
      See Also:

    • expiryMinutes

      public final Integer expiryMinutes()

      The number of minutes allowed for the proxy session.

      Returns:
      The number of minutes allowed for the proxy session.

    • capabilities

      public final List<Capability> capabilities()

      The proxy session capabilities.

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

      Returns:
      The proxy session capabilities.

    • hasCapabilities

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

    • capabilitiesAsStrings

      public final List<String> capabilitiesAsStrings()

      The proxy session capabilities.

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

      Returns:
      The proxy session capabilities.

    • createdTimestamp

      public final Instant createdTimestamp()

      The created time stamp, in ISO 8601 format.

      Returns:
      The created time stamp, in ISO 8601 format.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The updated time stamp, in ISO 8601 format.

      Returns:
      The updated time stamp, in ISO 8601 format.

    • endedTimestamp

      public final Instant endedTimestamp()

      The ended time stamp, in ISO 8601 format.

      Returns:
      The ended time stamp, in ISO 8601 format.

    • hasParticipants

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

    • participants

      public final List<Participant> participants()

      The proxy session participants.

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

      Returns:
      The proxy session participants.

    • numberSelectionBehavior

      public final NumberSelectionBehavior numberSelectionBehavior()

      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

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

      Returns:
      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
      See Also:

    • numberSelectionBehaviorAsString

      public final String numberSelectionBehaviorAsString()

      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

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

      Returns:
      The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
      See Also:

    • geoMatchLevel

      public final GeoMatchLevel geoMatchLevel()

      The preference for matching the country or area code of the proxy phone number with that of the first participant.

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

      Returns:
      The preference for matching the country or area code of the proxy phone number with that of the first participant.
      See Also:

    • geoMatchLevelAsString

      public final String geoMatchLevelAsString()

      The preference for matching the country or area code of the proxy phone number with that of the first participant.

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

      Returns:
      The preference for matching the country or area code of the proxy phone number with that of the first participant.
      See Also:

    • geoMatchParams

      public final GeoMatchParams geoMatchParams()

      The country and area code for the proxy phone number.

      Returns:
      The country and area code for the proxy phone number.

    • toBuilder

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

    • builder

      public static ProxySession.Builder builder()

    • serializableBuilderClass

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