software.amazon.awssdk.services.iot.model

Class StreamInfo

java.lang.Object

software.amazon.awssdk.services.iot.model.StreamInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StreamInfo.Builder,StreamInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class StreamInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StreamInfo.Builder,StreamInfo>

Information about a stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamInfo.Builder

Method Summary

Modifier and Type	Method and Description
static StreamInfo.Builder	builder()
Instant	createdAt() The date when the stream was created.
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 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()
Instant	lastUpdatedAt() The date when the stream was last updated.
String	roleArn() An IAM role IoT assumes to access your S3 files.
List<SdkField<?>>	sdkFields()
static Class<? extends StreamInfo.Builder>	serializableBuilderClass()
String	streamArn() The stream ARN.
String	streamId() The stream ID.
Integer	streamVersion() The stream version.
StreamInfo.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 java.lang.Object

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.

streamArn

public final String streamArn()

The stream ARN.

Returns:

The stream ARN.

streamVersion

public final Integer streamVersion()

The stream version.

Returns:

The stream version.

description

public final String description()

The description of the stream.

Returns:

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

createdAt

public final Instant createdAt()

The date when the stream was created.

Returns:

The date when the stream was created.

lastUpdatedAt

public final Instant lastUpdatedAt()

The date when the stream was last updated.

Returns:

The date when the stream was last updated.

roleArn

public final String roleArn()

An IAM role IoT assumes to access your S3 files.

Returns:

An IAM role IoT assumes to access your S3 files.

toBuilder

public StreamInfo.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<StreamInfo.Builder,StreamInfo>

Returns:

a builder for type T

builder

public static StreamInfo.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final 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 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)

sdkFields

public final 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.