Package 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("software.amazon.awssdk:codegen")
public final class DescribeDimensionKeysResponse
extends PiResponse
implements ToCopyableBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDimensionKeysResponse.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the Keys property.
boolean	hasPartitionKeys()	For responses, this returns true if the service returned a value for the PartitionKeys property.
List<DimensionKeyDescription>	keys()	The dimension keys that were requested.
String	nextToken()	A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the 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 final 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 final 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 final boolean hasPartitionKeys()

For responses, this returns true if the service returned a value for the PartitionKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

partitionKeys

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPartitionKeys() method.

Returns:

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

hasKeys

public final boolean hasKeys()

For responses, this returns true if the service returned a value for the Keys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

keys

public final List<DimensionKeyDescription> keys()

The dimension keys that were requested.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKeys() method.

Returns:

The dimension keys that were requested.

nextToken

public final String nextToken()

A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

Returns:

A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

toBuilder

public DescribeDimensionKeysResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDimensionKeysResponse.Builder,DescribeDimensionKeysResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDimensionKeysResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo