Package 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("software.amazon.awssdk:codegen")
public final class SampleChannelDataRequest
extends IoTAnalyticsRequest
implements ToCopyableBuilder<SampleChannelDataRequest.Builder,SampleChannelDataRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SampleChannelDataRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxMessages()	The number of sample messages to be retrieved.
Map<String,SdkField<?>>	sdkFieldNameToField()
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()
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 whose message samples are retrieved.

Returns:

The name of the channel whose message samples are retrieved.

maxMessages

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

Specified by:

toBuilder in interface ToCopyableBuilder<SampleChannelDataRequest.Builder,SampleChannelDataRequest>

Specified by:

toBuilder in class IoTAnalyticsRequest

builder

public static SampleChannelDataRequest.Builder builder()

serializableBuilderClass

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