software.amazon.awssdk.services.pi.model

Class DescribeDimensionKeysResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.pi.model.PiResponse

software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDimensionKeysResponse.Builder

Method Summary

Modifier and Type	Method and Description
Instant	alignedEndTime() The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds).
Instant	alignedStartTime() The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds).
static DescribeDimensionKeysResponse.Builder	builder()
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 SdkResponse.
int	hashCode()
List<DimensionKeyDescription>	keys() The dimension keys that were requested.
String	nextToken() An optional pagination token provided by a previous request.
List<ResponsePartitionKey>	partitionKeys() If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDimensionKeysResponse.Builder>	serializableBuilderClass()
DescribeDimensionKeysResponse.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.services.pi.model.PiResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

alignedStartTime

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

Returns:

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.

alignedEndTime

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

Returns:

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.

partitionKeys

public List<ResponsePartitionKey> partitionKeys()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

keys

public List<DimensionKeyDescription> keys()

The dimension keys that were requested.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The dimension keys that were requested.

nextToken

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

Returns:

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.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeDimensionKeysResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDimensionKeysResponse.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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.