Package software.amazon.awssdk.services.costexplorer.model

Class ListCostAllocationTagsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest
software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListCostAllocationTagsRequest.Builder,ListCostAllocationTagsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListCostAllocationTagsRequest extends CostExplorerRequest implements ToCopyableBuilder<ListCostAllocationTagsRequest.Builder,ListCostAllocationTagsRequest>

  • Method Details

    • status

      public final CostAllocationTagStatus status()

      The status of cost allocation tag keys that are returned for this request.

      If the service returns an enum value that is not available in the current SDK version, status will return CostAllocationTagStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of cost allocation tag keys that are returned for this request.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of cost allocation tag keys that are returned for this request.

      If the service returns an enum value that is not available in the current SDK version, status will return CostAllocationTagStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of cost allocation tag keys that are returned for this request.
      See Also:

    • hasTagKeys

      public final boolean hasTagKeys()
      For responses, this returns true if the service returned a value for the TagKeys 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.

    • tagKeys

      public final List<String> tagKeys()

      The list of cost allocation tag keys that are returned for this request.

      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 hasTagKeys() method.

      Returns:
      The list of cost allocation tag keys that are returned for this request.

    • type

      public final CostAllocationTagType type()

      The type of CostAllocationTag object that are returned for this request. The AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are tags that you define, create, and apply to resources.

      If the service returns an enum value that is not available in the current SDK version, type will return CostAllocationTagType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of CostAllocationTag object that are returned for this request. The AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are tags that you define, create, and apply to resources.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of CostAllocationTag object that are returned for this request. The AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are tags that you define, create, and apply to resources.

      If the service returns an enum value that is not available in the current SDK version, type will return CostAllocationTagType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of CostAllocationTag object that are returned for this request. The AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are tags that you define, create, and apply to resources.
      See Also:

    • nextToken

      public final String nextToken()

      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.

    • maxResults

      public final Integer maxResults()

      The maximum number of objects that are returned for this request. By default, the request returns 100 results.

      Returns:
      The maximum number of objects that are returned for this request. By default, the request returns 100 results.

    • toBuilder

      public ListCostAllocationTagsRequest.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<ListCostAllocationTagsRequest.Builder,ListCostAllocationTagsRequest>
      Specified by:
      toBuilder in class CostExplorerRequest
      Returns:
      a builder for type T

    • builder

      public static ListCostAllocationTagsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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 final 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.