Package software.amazon.awssdk.services.kinesisvideosignaling.model

Class IceServer

java.lang.Object

software.amazon.awssdk.services.kinesisvideosignaling.model.IceServer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IceServer.Builder,IceServer>

@Generated("software.amazon.awssdk:codegen")
public final class IceServer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IceServer.Builder,IceServer>

A structure for the ICE server connection data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IceServer.Builder

Method Summary

Modifier and Type	Method	Description
static IceServer.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUris()	For responses, this returns true if the service returned a value for the Uris property.
String	password()	A password to login to the ICE server.
List<SdkField<?>>	sdkFields()
static Class<? extends IceServer.Builder>	serializableBuilderClass()
IceServer.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	ttl()	The period of time, in seconds, during which the username and password are valid.
List<String>	uris()	An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec.
String	username()	A username to login to the ICE server.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasUris

public final boolean hasUris()

For responses, this returns true if the service returned a value for the Uris 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.

uris

public final List<String> uris()

An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different addresses and/or protocols that can be used to reach the TURN server.

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

Returns:

An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different addresses and/or protocols that can be used to reach the TURN server.

username

public final String username()

A username to login to the ICE server.

Returns:

A username to login to the ICE server.

password

public final String password()

A password to login to the ICE server.

Returns:

A password to login to the ICE server.

ttl

public final Integer ttl()

The period of time, in seconds, during which the username and password are valid.

Returns:

The period of time, in seconds, during which the username and password are valid.

toBuilder

public IceServer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IceServer.Builder,IceServer>

builder

public static IceServer.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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