Class CreateChannelRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateChannelRequest.Builder,
CreateChannelRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateChannelRequest.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> Returns the value of the Destinations property for this object.final EncoderSettings
Returns the value of the EncoderSettings property for this object.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Destinations 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 List
<InputAttachment> List of input attachments for channel.final InputSpecification
Specification of network and file inputs for this channelfinal LogLevel
logLevel()
The log level to write to CloudWatch Logs.final String
The log level to write to CloudWatch Logs.Maintenance settings for this channel.final String
name()
Name of channel.final String
Unique request ID to be specified.final String
reserved()
Deprecated.final String
roleArn()
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.static Class
<? extends CreateChannelRequest.Builder> 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.final VpcOutputSettings
vpc()
Settings for the VPC outputsMethods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Returns the value of the Destinations property for this object.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:
- The value of the Destinations property for this object.
-
encoderSettings
Returns the value of the EncoderSettings property for this object.- Returns:
- The value of the EncoderSettings property for this object.
-
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 to write 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 to write to CloudWatch Logs.
- See Also:
-
logLevelAsString
The log level to write 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 to write to CloudWatch Logs.
- See Also:
-
maintenance
Maintenance settings for this channel.- Returns:
- Maintenance settings for this channel.
-
name
Name of channel.- Returns:
- Name of channel.
-
requestId
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.- Returns:
- Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.
-
reserved
Deprecated.Deprecated field that's only usable by whitelisted customers.- Returns:
- Deprecated field that's only usable by whitelisted customers.
-
roleArn
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.- Returns:
- An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
-
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 the VPC outputs- Returns:
- Settings for the 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<CreateChannelRequest.Builder,
CreateChannelRequest> - Specified by:
toBuilder
in classMediaLiveRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-