Class CreateProxySessionRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateProxySessionRequest.Builder,CreateProxySessionRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateProxySessionRequest extends ChimeRequest implements ToCopyableBuilder<CreateProxySessionRequest.Builder,CreateProxySessionRequest>
  • Method Details

    • voiceConnectorId

      public final String voiceConnectorId()

      The Amazon Chime voice connector ID.

      Returns:
      The Amazon Chime voice connector ID.
    • hasParticipantPhoneNumbers

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

      public final List<String> participantPhoneNumbers()

      The participant phone numbers.

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

      Returns:
      The participant phone numbers.
    • name

      public final String name()

      The name of the proxy session.

      Returns:
      The name of the proxy session.
    • 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.
    • 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

      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<CreateProxySessionRequest.Builder,CreateProxySessionRequest>
      Specified by:
      toBuilder in class ChimeRequest
      Returns:
      a builder for type T
    • builder

      public static CreateProxySessionRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreateProxySessionRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.