Class SingleMasterChannelEndpointConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SingleMasterChannelEndpointConfiguration.Builder,
SingleMasterChannelEndpointConfiguration>
An object that contains the endpoint configuration for the SINGLE_MASTER
channel type.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Protocols property.final List
<ChannelProtocol> This property is used to determine the nature of communication over thisSINGLE_MASTER
signaling channel.This property is used to determine the nature of communication over thisSINGLE_MASTER
signaling channel.final ChannelRole
role()
This property is used to determine messaging permissions in thisSINGLE_MASTER
signaling channel.final String
This property is used to determine messaging permissions in thisSINGLE_MASTER
signaling channel.static Class
<? extends SingleMasterChannelEndpointConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
protocols
This property is used to determine the nature of communication over this
SINGLE_MASTER
signaling channel. IfWSS
is specified, this API returns a websocket endpoint. IfHTTPS
is specified, this API returns anHTTPS
endpoint.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
hasProtocols()
method.- Returns:
- This property is used to determine the nature of communication over this
SINGLE_MASTER
signaling channel. IfWSS
is specified, this API returns a websocket endpoint. IfHTTPS
is specified, this API returns anHTTPS
endpoint.
-
hasProtocols
public final boolean hasProtocols()For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
protocolsAsStrings
This property is used to determine the nature of communication over this
SINGLE_MASTER
signaling channel. IfWSS
is specified, this API returns a websocket endpoint. IfHTTPS
is specified, this API returns anHTTPS
endpoint.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
hasProtocols()
method.- Returns:
- This property is used to determine the nature of communication over this
SINGLE_MASTER
signaling channel. IfWSS
is specified, this API returns a websocket endpoint. IfHTTPS
is specified, this API returns anHTTPS
endpoint.
-
role
This property is used to determine messaging permissions in this
SINGLE_MASTER
signaling channel. IfMASTER
is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. IfVIEWER
is specified, this API returns an endpoint that a client can use only to send offers to anotherMASTER
client on this signaling channel.If the service returns an enum value that is not available in the current SDK version,
role
will returnChannelRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- Returns:
- This property is used to determine messaging permissions in this
SINGLE_MASTER
signaling channel. IfMASTER
is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. IfVIEWER
is specified, this API returns an endpoint that a client can use only to send offers to anotherMASTER
client on this signaling channel. - See Also:
-
roleAsString
This property is used to determine messaging permissions in this
SINGLE_MASTER
signaling channel. IfMASTER
is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. IfVIEWER
is specified, this API returns an endpoint that a client can use only to send offers to anotherMASTER
client on this signaling channel.If the service returns an enum value that is not available in the current SDK version,
role
will returnChannelRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- Returns:
- This property is used to determine messaging permissions in this
SINGLE_MASTER
signaling channel. IfMASTER
is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. IfVIEWER
is specified, this API returns an endpoint that a client can use only to send offers to anotherMASTER
client on this signaling channel. - See Also:
-
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 interfaceToCopyableBuilder<SingleMasterChannelEndpointConfiguration.Builder,
SingleMasterChannelEndpointConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SingleMasterChannelEndpointConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-