Class GetTagsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetTagsRequest.Builder,
GetTagsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GetTagsRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Expression
filter()
Returns the value of the Filter property for this object.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SortBy property.final Integer
This field is only used when SortBy is provided in the request.final String
The token to retrieve the next set of results.final String
The value that you want to search for.static Class
<? extends GetTagsRequest.Builder> final List
<SortDefinition> sortBy()
The value that you want to sort the data by.final String
tagKey()
The key of the tag that you want to return values for.final DateInterval
The start and end dates for retrieving the dimension values.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.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
searchString
The value that you want to search for.
- Returns:
- The value that you want to search for.
-
timePeriod
The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if
start
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.- Returns:
- The start and end dates for retrieving the dimension values. The start date is inclusive, but the end
date is exclusive. For example, if
start
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.
-
tagKey
The key of the tag that you want to return values for.
- Returns:
- The key of the tag that you want to return values for.
-
filter
Returns the value of the Filter property for this object.- Returns:
- The value of the Filter property for this object.
-
hasSortBy
public final boolean hasSortBy()For responses, this returns true if the service returned a value for the SortBy 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. -
sortBy
The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported values for
SortOrder
areASCENDING
andDESCENDING
.When you use
SortBy
,NextPageToken
andSearchString
aren't supported.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
hasSortBy()
method.- Returns:
- The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported values for
SortOrder
areASCENDING
andDESCENDING
.When you use
SortBy
,NextPageToken
andSearchString
aren't supported. -
-
-
maxResults
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.
For
GetTags
, MaxResults has an upper quota of 1000.- Returns:
- This field is only used when SortBy is provided in the request. The maximum number of objects that are
returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as
the default value for this parameter.
For
GetTags
, MaxResults has an upper quota of 1000.
-
nextPageToken
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
- Returns:
- The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
-
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<GetTagsRequest.Builder,
GetTagsRequest> - Specified by:
toBuilder
in classCostExplorerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-