Package software.amazon.awssdk.services.mediapackagev2.model

Class CreateChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediapackagev2.model.MediaPackageV2Request

software.amazon.awssdk.services.mediapackagev2.model.CreateChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateChannelRequest
extends MediaPackageV2Request
implements ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateChannelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateChannelRequest.Builder	builder()
String	channelGroupName()	The name that describes the channel group.
String	channelName()	The name that describes the channel.
String	clientToken()	A unique, case-sensitive token that you provide to ensure the idempotency of the request.
String	description()	Enter any descriptive text that helps you to identify the channel.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateChannelRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A comma-separated list of tag key:value pairs that you define.
CreateChannelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

channelGroupName

public final String channelGroupName()

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

Returns:

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

channelName

public final String channelName()

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

Returns:

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

clientToken

public final String clientToken()

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

description

public final String description()

Enter any descriptive text that helps you to identify the channel.

Returns:

Enter any descriptive text that helps you to identify 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 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 comma-separated list of tag key:value pairs that you define. For example:

"Key1": "Value1",

"Key2": "Value2"

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 comma-separated list of tag key:value pairs that you define. For example:

"Key1": "Value1",

"Key2": "Value2"

toBuilder

public CreateChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Specified by:

toBuilder in class MediaPackageV2Request

builder

public static CreateChannelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateChannelRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo