software.amazon.awssdk.services.iot.model

Class UpdateStreamRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateStreamRequest.Builder,UpdateStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateStreamRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateStreamRequest.Builder	builder()
String	description() The description of the stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<StreamFile>	files() The files associated with the stream.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasFiles() Returns true if the Files property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	roleArn() An IAM role that allows the IoT service principal assumes to access your S3 files.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateStreamRequest.Builder>	serializableBuilderClass()
String	streamId() The stream ID.
UpdateStreamRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamId

public String streamId()

The stream ID.

Returns:

The stream ID.

description

public String description()

The description of the stream.

Returns:

The description of the stream.

hasFiles

public boolean hasFiles()

Returns true if the Files property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

files

public List<StreamFile> files()

The files associated with the stream.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFiles() to see if a value was sent in this field.

Returns:

The files associated with the stream.

roleArn

public String roleArn()

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

Returns:

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

toBuilder

public UpdateStreamRequest.Builder 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 interface ToCopyableBuilder<UpdateStreamRequest.Builder,UpdateStreamRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static UpdateStreamRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.