Class GetIceServerConfigRequest

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

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

    • channelARN

      public final String channelARN()

      The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

      Returns:
      The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
    • clientId

      public final String clientId()

      Unique identifier for the viewer. Must be unique within the signaling channel.

      Returns:
      Unique identifier for the viewer. Must be unique within the signaling channel.
    • service

      public final Service service()

      Specifies the desired service. Currently, TURN is the only valid value.

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

      Returns:
      Specifies the desired service. Currently, TURN is the only valid value.
      See Also:
    • serviceAsString

      public final String serviceAsString()

      Specifies the desired service. Currently, TURN is the only valid value.

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

      Returns:
      Specifies the desired service. Currently, TURN is the only valid value.
      See Also:
    • username

      public final String username()

      An optional user ID to be associated with the credentials.

      Returns:
      An optional user ID to be associated with the credentials.
    • 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<GetIceServerConfigRequest.Builder,GetIceServerConfigRequest>
      Specified by:
      toBuilder in class KinesisVideoSignalingRequest
      Returns:
      a builder for type T
    • builder

      public static GetIceServerConfigRequest.Builder builder()
    • serializableBuilderClass

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