software.amazon.awssdk.services.ivs.model

Class ChannelSummary

java.lang.Object

software.amazon.awssdk.services.ivs.model.ChannelSummary

All Implemented Interfaces:

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

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

Summary information about a channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Channel ARN.
Boolean	authorized() Whether the channel is private (enabled for playback authorization).
static ChannelSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
ChannelLatencyMode	latencyMode() Channel latency mode.
String	latencyModeAsString() Channel latency mode.
String	name() Channel name.
String	recordingConfigurationArn() Recording-configuration ARN.
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelSummary.Builder>	serializableBuilderClass()
Map<String,String>	tags() Array of 1-50 maps, each of the form string:string (key:value).
ChannelSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

arn

public final String arn()

Channel ARN.

Returns:

Channel ARN.

authorized

public final Boolean authorized()

Whether the channel is private (enabled for playback authorization). Default: false.

Returns:

Whether the channel is private (enabled for playback authorization). Default: false.

latencyMode

public final ChannelLatencyMode latencyMode()

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

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

Returns:

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

See Also:

ChannelLatencyMode

latencyModeAsString

public final String latencyModeAsString()

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

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

Returns:

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

See Also:

ChannelLatencyMode

name

public final String name()

Channel name.

Returns:

Channel name.

recordingConfigurationArn

public final String recordingConfigurationArn()

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

Returns:

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

Returns:

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

toBuilder

public ChannelSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelSummary.Builder,ChannelSummary>

builder

public static ChannelSummary.Builder builder()

serializableBuilderClass

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