Package software.amazon.awssdk.services.iot.model

Class CreateStreamRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.CreateStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateStreamRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateStreamRequest.Builder	builder()
String	description()	A description of the stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<StreamFile>	files()	The files to stream.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFiles()	For responses, this returns true if the service returned a value for the Files property.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	roleArn()	An IAM role that allows the IoT service principal to access your S3 files.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStreamRequest.Builder>	serializableBuilderClass()
String	streamId()	The stream ID.
List<Tag>	tags()	Metadata which can be used to manage streams.
CreateStreamRequest.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

streamId

public final String streamId()

The stream ID.

Returns:

The stream ID.

description

public final String description()

A description of the stream.

Returns:

A description of the stream.

hasFiles

public final boolean hasFiles()

For responses, this returns true if the service returned a value for the Files 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.

files

public final List<StreamFile> files()

The files to stream.

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 hasFiles() method.

Returns:

The files to stream.

roleArn

public final String roleArn()

An IAM role that allows the IoT service principal to access your S3 files.

Returns:

An IAM role that allows the IoT service principal to access your S3 files.

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 streams.

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 streams.

toBuilder

public CreateStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateStreamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateStreamRequest.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