java.lang.Object
- software.amazon.awssdk.services.medialive.model.ChannelSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ChannelSummary.Builder,ChannelSummary>

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

Placeholder documentation for ChannelSummary

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ChannelSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DescribeAnywhereSettings`	`anywhereSettings()`	AnywhereSettings settings for this channel.
`String`	`arn()`	The unique arn of the channel.
`static ChannelSummary.Builder`	`builder()`
`CdiInputSpecification`	`cdiInputSpecification()`	Specification of CDI inputs for this channel
`ChannelClass`	`channelClass()`	The class for this channel.
`String`	`channelClassAsString()`	The class for this channel.
`ChannelEngineVersionResponse`	`channelEngineVersion()`	The engine version that you requested for this channel.
`List<OutputDestination>`	`destinations()`	A list of destinations of the channel.
`List<ChannelEgressEndpoint>`	`egressEndpoints()`	The endpoints where outgoing connections initiate from
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestinations()`	For responses, this returns true if the service returned a value for the Destinations property.
`boolean`	`hasEgressEndpoints()`	For responses, this returns true if the service returned a value for the EgressEndpoints property.
`int`	`hashCode()`
`boolean`	`hasInputAttachments()`	For responses, this returns true if the service returned a value for the InputAttachments property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasUsedChannelEngineVersions()`	For responses, this returns true if the service returned a value for the UsedChannelEngineVersions property.
`String`	`id()`	The unique id of the channel.
`List<InputAttachment>`	`inputAttachments()`	List of input attachments for channel.
`InputSpecification`	`inputSpecification()`	Specification of network and file inputs for this channel
`LogLevel`	`logLevel()`	The log level being written to CloudWatch Logs.
`String`	`logLevelAsString()`	The log level being written to CloudWatch Logs.
`MaintenanceStatus`	`maintenance()`	Maintenance settings for this channel.
`String`	`name()`	The name of the channel.
`Integer`	`pipelinesRunningCount()`	The number of currently healthy pipelines.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the role assumed when running the Channel.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ChannelSummary.Builder>`	`serializableBuilderClass()`
`ChannelState`	`state()`	Returns the value of the State property for this object.
`String`	`stateAsString()`	Returns the value of the State property for this object.
`Map<String,String>`	`tags()`	A collection of key-value pairs.
`ChannelSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<ChannelEngineVersionResponse>`	`usedChannelEngineVersions()`	The engine version that the running pipelines are using.
`VpcOutputSettingsDescription`	`vpc()`	Settings for any VPC outputs.

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()
```
    The unique arn of the channel.
    
    Returns:
    
    The unique arn of the channel.
  - cdiInputSpecification
```
public final CdiInputSpecification cdiInputSpecification()
```
    Specification of CDI inputs for this channel
    
    Returns:
    
    Specification of CDI inputs for this channel
  - channelClass
```
public final ChannelClass channelClass()
```
    The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
    If the service returns an enum value that is not available in the current SDK version, channelClass will return ChannelClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelClassAsString().
    
    Returns:
    
    The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
    
    See Also:
    
    ChannelClass
  - channelClassAsString
```
public final String channelClassAsString()
```
    The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
    If the service returns an enum value that is not available in the current SDK version, channelClass will return ChannelClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelClassAsString().
    
    Returns:
    
    The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
    
    See Also:
    
    ChannelClass
  - hasDestinations
```
public final boolean hasDestinations()
```
    For responses, this returns true if the service returned a value for the Destinations 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.
  - destinations
```
public final List<OutputDestination> destinations()
```
    A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
    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 hasDestinations() method.
    
    Returns:
    
    A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
  - hasEgressEndpoints
```
public final boolean hasEgressEndpoints()
```
    For responses, this returns true if the service returned a value for the EgressEndpoints 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.
  - egressEndpoints
```
public final List<ChannelEgressEndpoint> egressEndpoints()
```
    The endpoints where outgoing connections initiate from
    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 hasEgressEndpoints() method.
    
    Returns:
    
    The endpoints where outgoing connections initiate from
  - id
```
public final String id()
```
    The unique id of the channel.
    
    Returns:
    
    The unique id of the channel.
  - hasInputAttachments
```
public final boolean hasInputAttachments()
```
    For responses, this returns true if the service returned a value for the InputAttachments 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.
  - inputAttachments
```
public final List<InputAttachment> inputAttachments()
```
    List of input attachments for channel.
    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 hasInputAttachments() method.
    
    Returns:
    
    List of input attachments for channel.
  - inputSpecification
```
public final InputSpecification inputSpecification()
```
    Specification of network and file inputs for this channel
    
    Returns:
    
    Specification of network and file inputs for this channel
  - logLevel
```
public final LogLevel logLevel()
```
    The log level being written to CloudWatch Logs.
    If the service returns an enum value that is not available in the current SDK version, logLevel will return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().
    
    Returns:
    
    The log level being written to CloudWatch Logs.
    
    See Also:
    
    LogLevel
  - logLevelAsString
```
public final String logLevelAsString()
```
    The log level being written to CloudWatch Logs.
    If the service returns an enum value that is not available in the current SDK version, logLevel will return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().
    
    Returns:
    
    The log level being written to CloudWatch Logs.
    
    See Also:
    
    LogLevel
  - maintenance
```
public final MaintenanceStatus maintenance()
```
    Maintenance settings for this channel.
    
    Returns:
    
    Maintenance settings for this channel.
  - name
```
public final String name()
```
    The name of the channel. (user-mutable)
    
    Returns:
    
    The name of the channel. (user-mutable)
  - pipelinesRunningCount
```
public final Integer pipelinesRunningCount()
```
    The number of currently healthy pipelines.
    
    Returns:
    
    The number of currently healthy pipelines.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the role assumed when running the Channel.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role assumed when running the Channel.
  - state
```
public final ChannelState state()
```
    Returns the value of the State property for this object.
    If the service returns an enum value that is not available in the current SDK version, state will return ChannelState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The value of the State property for this object.
    
    See Also:
    
    ChannelState
  - stateAsString
```
public final String stateAsString()
```
    Returns the value of the State property for this object.
    If the service returns an enum value that is not available in the current SDK version, state will return ChannelState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The value of the State property for this object.
    
    See Also:
    
    ChannelState
  - 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()
```
    A collection of key-value pairs.
    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:
    
    A collection of key-value pairs.
  - vpc
```
public final VpcOutputSettingsDescription vpc()
```
    Settings for any VPC outputs.
    
    Returns:
    
    Settings for any VPC outputs.
  - anywhereSettings
```
public final DescribeAnywhereSettings anywhereSettings()
```
    AnywhereSettings settings for this channel.
    
    Returns:
    
    AnywhereSettings settings for this channel.
  - channelEngineVersion
```
public final ChannelEngineVersionResponse channelEngineVersion()
```
    The engine version that you requested for this channel.
    
    Returns:
    
    The engine version that you requested for this channel.
  - hasUsedChannelEngineVersions
```
public final boolean hasUsedChannelEngineVersions()
```
    For responses, this returns true if the service returned a value for the UsedChannelEngineVersions 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.
  - usedChannelEngineVersions
```
public final List<ChannelEngineVersionResponse> usedChannelEngineVersions()
```
    The engine version that the running pipelines are using.
    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 hasUsedChannelEngineVersions() method.
    
    Returns:
    
    The engine version that the running pipelines are using.
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ChannelSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

cdiInputSpecification

channelClass

channelClassAsString

hasDestinations

destinations

hasEgressEndpoints

egressEndpoints

id

hasInputAttachments

inputAttachments

inputSpecification

logLevel

logLevelAsString

maintenance

name

pipelinesRunningCount

roleArn

state

stateAsString

hasTags

tags

vpc

anywhereSettings

channelEngineVersion

hasUsedChannelEngineVersions

usedChannelEngineVersions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField