software.amazon.awssdk.services.iotanalytics.model

Class SampleChannelDataRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SampleChannelDataRequest.Builder,SampleChannelDataRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SampleChannelDataRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SampleChannelDataRequest.Builder	builder()
String	channelName() The name of the channel whose message samples are retrieved.
Instant	endTime() The end of the time window from which sample messages are retrieved.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxMessages() The number of sample messages to be retrieved.
List<SdkField<?>>	sdkFields()
static Class<? extends SampleChannelDataRequest.Builder>	serializableBuilderClass()
Instant	startTime() The start of the time window from which sample messages are retrieved.
SampleChannelDataRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

channelName

public String channelName()

The name of the channel whose message samples are retrieved.

Returns:

The name of the channel whose message samples are retrieved.

maxMessages

public Integer maxMessages()

The number of sample messages to be retrieved. The limit is 10, the default is also 10.

Returns:

The number of sample messages to be retrieved. The limit is 10, the default is also 10.

startTime

public Instant startTime()

The start of the time window from which sample messages are retrieved.

Returns:

The start of the time window from which sample messages are retrieved.

endTime

public Instant endTime()

The end of the time window from which sample messages are retrieved.

Returns:

The end of the time window from which sample messages are retrieved.

toBuilder

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

Specified by:

toBuilder in class IoTAnalyticsRequest

Returns:

a builder for type T

builder

public static SampleChannelDataRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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.