Class ChannelSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ChannelSummary.Builder,
ChannelSummary>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The unique arn of the channel.static ChannelSummary.Builder
builder()
final CdiInputSpecification
Specification of CDI inputs for this channelfinal ChannelClass
The class for this channel.final String
The class for this channel.final List
<OutputDestination> A list of destinations of the channel.final List
<ChannelEgressEndpoint> The endpoints where outgoing connections initiate fromfinal 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 boolean
For responses, this returns true if the service returned a value for the Destinations property.final boolean
For responses, this returns true if the service returned a value for the EgressEndpoints property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputAttachments property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The unique id of the channel.final List
<InputAttachment> List of input attachments for channel.final InputSpecification
Specification of network and file inputs for this channelfinal LogLevel
logLevel()
The log level being written to CloudWatch Logs.final String
The log level being written to CloudWatch Logs.final MaintenanceStatus
Maintenance settings for this channel.final String
name()
The name of the channel.final Integer
The number of currently healthy pipelines.final String
roleArn()
The Amazon Resource Name (ARN) of the role assumed when running the Channel.static Class
<? extends ChannelSummary.Builder> final ChannelState
state()
Returns the value of the State property for this object.final String
Returns the value of the State property for this object.tags()
A collection of key-value pairs.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.vpc()
Settings for any VPC outputs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The unique arn of the channel.- Returns:
- The unique arn of the channel.
-
cdiInputSpecification
Specification of CDI inputs for this channel- Returns:
- Specification of CDI inputs for this channel
-
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 returnChannelClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelClassAsString()
.- Returns:
- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
- See Also:
-
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 returnChannelClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelClassAsString()
.- Returns:
- The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
- See Also:
-
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 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. -
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 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. -
egressEndpoints
The endpoints where outgoing connections initiate fromAttempts 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
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 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. -
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
Specification of network and file inputs for this channel- Returns:
- Specification of network and file inputs for this channel
-
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 returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogLevelAsString()
.- Returns:
- The log level being written to CloudWatch Logs.
- See Also:
-
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 returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogLevelAsString()
.- Returns:
- The log level being written to CloudWatch Logs.
- See Also:
-
maintenance
Maintenance settings for this channel.- Returns:
- Maintenance settings for this channel.
-
name
The name of the channel. (user-mutable)- Returns:
- The name of the channel. (user-mutable)
-
pipelinesRunningCount
The number of currently healthy pipelines.- Returns:
- The number of currently healthy pipelines.
-
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
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 returnChannelState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The value of the State property for this object.
- See Also:
-
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 returnChannelState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The value of the State property for this object.
- See Also:
-
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 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. -
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
Settings for any VPC outputs.- Returns:
- Settings for any VPC outputs.
-
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<ChannelSummary.Builder,
ChannelSummary> - Returns:
- a builder for type T
-
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
-