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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKeys() Returns true if the Keys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasPartitionKeys() Returns true if the PartitionKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.

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

clone, finalize, 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.

hasPartitionKeys

public boolean hasPartitionKeys()

Returns true if the PartitionKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasPartitionKeys() to see if a value was sent in this field.

Returns:

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

hasKeys

public boolean hasKeys()

Returns true if the Keys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasKeys() to see if a value was sent in this field.

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDimensionKeysResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDimensionKeysResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo