IceServer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisvideosignalingchannels.model.IceServer

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IceServer
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure for the ICE server connection data.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IceServer()

Constructors
Constructor and Description
`IceServer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IceServer`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getPassword()` A password to login to the ICE server.
`Integer`	`getTtl()` The period of time, in seconds, during which the username and password are valid.
`List<String>`	`getUris()` An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec.
`String`	`getUsername()` A username to login to the ICE server.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setPassword(String password)` A password to login to the ICE server.
`void`	`setTtl(Integer ttl)` The period of time, in seconds, during which the username and password are valid.
`void`	`setUris(Collection<String> uris)` An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec.
`void`	`setUsername(String username)` A username to login to the ICE server.
`String`	`toString()` Returns a string representation of this object.
`IceServer`	`withPassword(String password)` A password to login to the ICE server.
`IceServer`	`withTtl(Integer ttl)` The period of time, in seconds, during which the username and password are valid.
`IceServer`	`withUris(Collection<String> uris)` An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec.
`IceServer`	`withUris(String... uris)` An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec.
`IceServer`	`withUsername(String username)` A username to login to the ICE server.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IceServer
```
public IceServer()
```
- Method Detail
  - getUris
```
public List<String> getUris()
```
    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.
    
    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.
  - setUris
```
public void setUris(Collection<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.
    
    Parameters:
    
    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.
  - withUris
```
public IceServer withUris(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setUris(java.util.Collection) or withUris(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUris
```
public IceServer withUris(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    A username to login to the ICE server.
    
    Parameters:
    
    username - A username to login to the ICE server.
  - getUsername
```
public String getUsername()
```
    A username to login to the ICE server.
    
    Returns:
    
    A username to login to the ICE server.
  - withUsername
```
public IceServer withUsername(String username)
```
    A username to login to the ICE server.
    
    Parameters:
    
    username - A username to login to the ICE server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(String password)
```
    A password to login to the ICE server.
    
    Parameters:
    
    password - A password to login to the ICE server.
  - getPassword
```
public String getPassword()
```
    A password to login to the ICE server.
    
    Returns:
    
    A password to login to the ICE server.
  - withPassword
```
public IceServer withPassword(String password)
```
    A password to login to the ICE server.
    
    Parameters:
    
    password - A password to login to the ICE server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTtl
```
public void setTtl(Integer ttl)
```
    The period of time, in seconds, during which the username and password are valid.
    
    Parameters:
    
    ttl - The period of time, in seconds, during which the username and password are valid.
  - getTtl
```
public Integer getTtl()
```
    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.
  - withTtl
```
public IceServer withTtl(Integer ttl)
```
    The period of time, in seconds, during which the username and password are valid.
    
    Parameters:
    
    ttl - The period of time, in seconds, during which the username and password are valid.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IceServer clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class IceServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IceServer

Method Detail

getUris

setUris

withUris

withUris

setUsername

getUsername

withUsername

setPassword

getPassword

withPassword

setTtl

getTtl

withTtl

toString

equals

hashCode

clone

marshall