Class DescribeDimensionKeysResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeDimensionKeysResponse.Builder,
DescribeDimensionKeysResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
The end time for the returned dimension keys, after alignment to a granular boundary (as specified byPeriodInSeconds
).final Instant
The start time for the returned dimension keys, after alignment to a granular boundary (as specified byPeriodInSeconds
).builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasKeys()
For responses, this returns true if the service returned a value for the Keys property.final boolean
For responses, this returns true if the service returned a value for the PartitionKeys property.final List
<DimensionKeyDescription> keys()
The dimension keys that were requested.final String
A pagination token that indicates the response didn’t return all available records becauseMaxRecords
was specified in the previous request.final List
<ResponsePartitionKey> IfPartitionBy
was present in the request,PartitionKeys
contains the breakdown of dimension keys by the specified partitions.static Class
<? extends DescribeDimensionKeysResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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-specifiedStartTime
.- 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-specifiedStartTime
.
-
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-specifiedEndtime
.- 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-specifiedEndtime
.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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, specifyNextToken
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, specifyNextToken
in a separate request with this value.
-
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 interfaceToCopyableBuilder<DescribeDimensionKeysResponse.Builder,
DescribeDimensionKeysResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-