Package software.amazon.awssdk.services.iotanalytics.model

Class CreateChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest

software.amazon.awssdk.services.iotanalytics.model.CreateChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateChannelRequest
extends IoTAnalyticsRequest
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	channelName()	The name of the channel.
ChannelStorage	channelStorage()	Where channel data is stored.
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.
RetentionPeriod	retentionPeriod()	How long, in days, message data is kept for the channel.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateChannelRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Metadata which can be used to manage the channel.
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

channelName

public final String channelName()

The name of the channel.

Returns:

The name of the channel.

channelStorage

public final ChannelStorage channelStorage()

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

Returns:

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

retentionPeriod

public final RetentionPeriod retentionPeriod()

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

Returns:

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

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 List<Tag> tags()

Metadata which can be used to manage the 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 hasTags() method.

Returns:

Metadata which can be used to manage the channel.

toBuilder

public CreateChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Specified by:

toBuilder in class IoTAnalyticsRequest

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo