software.amazon.awssdk.services.pi.model

Interface DescribeDimensionKeysResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>, PiResponse.Builder, SdkBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDimensionKeysResponse

public static interface DescribeDimensionKeysResponse.Builder
extends PiResponse.Builder, SdkPojo, CopyableBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>

Method Summary

Modifier and Type	Method and Description
DescribeDimensionKeysResponse.Builder	alignedEndTime(Instant alignedEndTime) The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds).
DescribeDimensionKeysResponse.Builder	alignedStartTime(Instant alignedStartTime) The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds).
DescribeDimensionKeysResponse.Builder	keys(Collection<DimensionKeyDescription> keys) The dimension keys that were requested.
DescribeDimensionKeysResponse.Builder	keys(Consumer<DimensionKeyDescription.Builder>... keys) The dimension keys that were requested.
DescribeDimensionKeysResponse.Builder	keys(DimensionKeyDescription... keys) The dimension keys that were requested.
DescribeDimensionKeysResponse.Builder	nextToken(String nextToken) An optional pagination token provided by a previous request.
DescribeDimensionKeysResponse.Builder	partitionKeys(Collection<ResponsePartitionKey> partitionKeys) If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
DescribeDimensionKeysResponse.Builder	partitionKeys(Consumer<ResponsePartitionKey.Builder>... partitionKeys) If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
DescribeDimensionKeysResponse.Builder	partitionKeys(ResponsePartitionKey... partitionKeys) If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

Methods inherited from interface software.amazon.awssdk.services.pi.model.PiResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

alignedStartTime

DescribeDimensionKeysResponse.Builder alignedStartTime(Instant alignedStartTime)

The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

Parameters:

alignedStartTime - The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

Returns:

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

alignedEndTime

DescribeDimensionKeysResponse.Builder alignedEndTime(Instant alignedEndTime)

The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

Parameters:

alignedEndTime - The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

Returns:

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

partitionKeys

DescribeDimensionKeysResponse.Builder partitionKeys(Collection<ResponsePartitionKey> partitionKeys)

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

Parameters:

partitionKeys - If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

Returns:

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

partitionKeys

DescribeDimensionKeysResponse.Builder partitionKeys(ResponsePartitionKey... partitionKeys)

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

Parameters:

partitionKeys - If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

Returns:

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

partitionKeys

DescribeDimensionKeysResponse.Builder partitionKeys(Consumer<ResponsePartitionKey.Builder>... partitionKeys)

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #partitionKeys(List).

Parameters:

partitionKeys - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#partitionKeys(List)

keys

DescribeDimensionKeysResponse.Builder keys(Collection<DimensionKeyDescription> keys)

The dimension keys that were requested.

Parameters:

keys - The dimension keys that were requested.

Returns:

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

keys

DescribeDimensionKeysResponse.Builder keys(DimensionKeyDescription... keys)

The dimension keys that were requested.

Parameters:

keys - The dimension keys that were requested.

Returns:

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

keys

DescribeDimensionKeysResponse.Builder keys(Consumer<DimensionKeyDescription.Builder>... keys)

The dimension keys that were requested.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #keys(List).

Parameters:

keys - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#keys(List)

nextToken

DescribeDimensionKeysResponse.Builder nextToken(String nextToken)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

Parameters:

nextToken - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

Returns:

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