Interface GetCaptureDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetCaptureDataRequest.Builder,GetCaptureDataRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<GetCaptureDataRequest.Builder,GetCaptureDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetCaptureDataRequest

@Mutable
@NotThreadSafe
public static interface GetCaptureDataRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<GetCaptureDataRequest.Builder,GetCaptureDataRequest>

Method Summary

Modifier and Type	Method	Description
default GetCaptureDataRequest.Builder	endTime(Consumer<TimeInNanos.Builder> endTime)	The end time for the video data range.
GetCaptureDataRequest.Builder	endTime(TimeInNanos endTime)	The end time for the video data range.
default GetCaptureDataRequest.Builder	formatSettings(Consumer<FormatSettings.Builder> formatSettings)	The optional format settings for the output.
GetCaptureDataRequest.Builder	formatSettings(FormatSettings formatSettings)	The optional format settings for the output.
GetCaptureDataRequest.Builder	nextToken(String nextToken)	The token from a previous response used to continue retrieving data.
GetCaptureDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetCaptureDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetCaptureDataRequest.Builder	propertyAlias(String propertyAlias)	The property alias that identifies the capture source.
default GetCaptureDataRequest.Builder	startTime(Consumer<TimeInNanos.Builder> startTime)	The start time for the video data range.
GetCaptureDataRequest.Builder	startTime(TimeInNanos startTime)	The start time for the video data range.
GetCaptureDataRequest.Builder	timeSeriesId(String timeSeriesId)	The time series ID that identifies the capture source.
GetCaptureDataRequest.Builder	workspaceName(String workspaceName)	The name of the workspace that contains the capture source.

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.iotsitewise.model.IoTSiteWiseRequest.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

workspaceName

GetCaptureDataRequest.Builder workspaceName(String workspaceName)

The name of the workspace that contains the capture source.

Parameters:

workspaceName - The name of the workspace that contains the capture source.

Returns:

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

startTime

GetCaptureDataRequest.Builder startTime(TimeInNanos startTime)

The start time for the video data range.

Parameters:

startTime - The start time for the video data range.

Returns:

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

startTime

default GetCaptureDataRequest.Builder startTime(Consumer<TimeInNanos.Builder> startTime)

The start time for the video data range.

This is a convenience method that creates an instance of the TimeInNanos.Builder avoiding the need to create one manually via TimeInNanos.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to startTime(TimeInNanos).

Parameters:

startTime - a consumer that will call methods on TimeInNanos.Builder

Returns:

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

See Also:

• startTime(TimeInNanos)

endTime

GetCaptureDataRequest.Builder endTime(TimeInNanos endTime)

The end time for the video data range. Must be greater than startTime.

Parameters:

endTime - The end time for the video data range. Must be greater than startTime.

Returns:

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

endTime

default GetCaptureDataRequest.Builder endTime(Consumer<TimeInNanos.Builder> endTime)

The end time for the video data range. Must be greater than startTime.

This is a convenience method that creates an instance of the TimeInNanos.Builder avoiding the need to create one manually via TimeInNanos.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endTime(TimeInNanos).

Parameters:

endTime - a consumer that will call methods on TimeInNanos.Builder

Returns:

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

See Also:

• endTime(TimeInNanos)

timeSeriesId

GetCaptureDataRequest.Builder timeSeriesId(String timeSeriesId)

The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.

Parameters:

timeSeriesId - The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.

Returns:

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

propertyAlias

GetCaptureDataRequest.Builder propertyAlias(String propertyAlias)

The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.

Parameters:

propertyAlias - The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.

Returns:

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

formatSettings

GetCaptureDataRequest.Builder formatSettings(FormatSettings formatSettings)

The optional format settings for the output.

Parameters:

formatSettings - The optional format settings for the output.

Returns:

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

formatSettings

default GetCaptureDataRequest.Builder formatSettings(Consumer<FormatSettings.Builder> formatSettings)

The optional format settings for the output.

This is a convenience method that creates an instance of the FormatSettings.Builder avoiding the need to create one manually via FormatSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to formatSettings(FormatSettings).

Parameters:

formatSettings - a consumer that will call methods on FormatSettings.Builder

Returns:

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

See Also:

• formatSettings(FormatSettings)

nextToken

GetCaptureDataRequest.Builder nextToken(String nextToken)

The token from a previous response used to continue retrieving data.

Parameters:

nextToken - The token from a previous response used to continue retrieving data.

Returns:

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

overrideConfiguration

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

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