Class GetCostCategoriesRequest

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.GetCostCategoriesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCostCategoriesRequest.Builder,GetCostCategoriesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetCostCategoriesRequest extends CostExplorerRequest implements ToCopyableBuilder<GetCostCategoriesRequest.Builder,GetCostCategoriesRequest>

  • Method Details

    • searchString

      public final String searchString()

      The value that you want to search the filter values for.

      If you don't specify a CostCategoryName, SearchString is used to filter Cost Category names that match the SearchString pattern. If you specify a CostCategoryName, SearchString is used to filter Cost Category values that match the SearchString pattern.

      Returns:
      The value that you want to search the filter values for.

      If you don't specify a CostCategoryName, SearchString is used to filter Cost Category names that match the SearchString pattern. If you specify a CostCategoryName, SearchString is used to filter Cost Category values that match the SearchString pattern.

    • timePeriod

      public final DateInterval timePeriod()
      Returns the value of the TimePeriod property for this object.
      Returns:
      The value of the TimePeriod property for this object.

    • costCategoryName

      public final String costCategoryName()
      Returns the value of the CostCategoryName property for this object.
      Returns:
      The value of the CostCategoryName property for this object.

    • filter

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

    • sortBy

      public final List<SortDefinition> sortBy()

      The value that you sort the data by.

      The key represents the cost and usage metrics. The following values are supported:

      • BlendedCost

      • UnblendedCost

      • AmortizedCost

      • NetAmortizedCost

      • NetUnblendedCost

      • UsageQuantity

      • NormalizedUsageAmount

      The supported key values for the SortOrder value are ASCENDING and DESCENDING.

      When you use the SortBy value, the NextPageToken and SearchString key values 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 sort the data by.

      The key represents the cost and usage metrics. The following values are supported:

      • BlendedCost

      • UnblendedCost

      • AmortizedCost

      • NetAmortizedCost

      • NetUnblendedCost

      • UsageQuantity

      • NormalizedUsageAmount

      The supported key values for the SortOrder value are ASCENDING and DESCENDING.

      When you use the SortBy value, the NextPageToken and SearchString key values aren't supported.

    • billingViewArn

      public final String billingViewArn()

      The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

    • maxResults

      public final Integer maxResults()

      This field is only used when the SortBy value is provided in the request.

      The maximum number of objects that are returned for this request. If MaxResults isn't specified with the SortBy value, the request returns 1000 results as the default value for this parameter.

      For GetCostCategories, MaxResults has an upper quota of 1000.

      Returns:
      This field is only used when the SortBy value is provided in the request.

      The maximum number of objects that are returned for this request. If MaxResults isn't specified with the SortBy value, the request returns 1000 results as the default value for this parameter.

      For GetCostCategories, MaxResults has an upper quota of 1000.

    • nextPageToken

      public final String nextPageToken()

      If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.

      Returns:
      If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.

    • toBuilder

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

    • builder

      public static GetCostCategoriesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCostCategoriesRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.