Interface SampleChannelDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SampleChannelDataRequest.Builder,SampleChannelDataRequest>, IoTAnalyticsRequest.Builder, SdkBuilder<SampleChannelDataRequest.Builder,SampleChannelDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SampleChannelDataRequest

@Mutable
@NotThreadSafe
public static interface SampleChannelDataRequest.Builder
extends IoTAnalyticsRequest.Builder, SdkPojo, CopyableBuilder<SampleChannelDataRequest.Builder,SampleChannelDataRequest>

Method Summary

Modifier and Type	Method	Description
SampleChannelDataRequest.Builder	channelName(String channelName)	The name of the channel whose message samples are retrieved.
SampleChannelDataRequest.Builder	endTime(Instant endTime)	The end of the time window from which sample messages are retrieved.
SampleChannelDataRequest.Builder	maxMessages(Integer maxMessages)	The number of sample messages to be retrieved.
SampleChannelDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SampleChannelDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SampleChannelDataRequest.Builder	startTime(Instant startTime)	The start of the time window from which sample messages are retrieved.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

channelName

SampleChannelDataRequest.Builder channelName(String channelName)

The name of the channel whose message samples are retrieved.

Parameters:

channelName - The name of the channel whose message samples are retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxMessages

SampleChannelDataRequest.Builder maxMessages(Integer maxMessages)

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

Parameters:

maxMessages - The number of sample messages to be retrieved. The limit is 10. The default is also 10.

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

SampleChannelDataRequest.Builder startTime(Instant startTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

SampleChannelDataRequest.Builder endTime(Instant endTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

SampleChannelDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SampleChannelDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.