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

Interface GetCostCategoriesRequest.Builder

    • Method Detail

      • searchString

        GetCostCategoriesRequest.Builder searchString​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • timePeriod

        GetCostCategoriesRequest.Builder timePeriod​(DateInterval timePeriod)
        Sets the value of the TimePeriod property for this object.
        Parameters:
        timePeriod - The new value for the TimePeriod property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • costCategoryName

        GetCostCategoriesRequest.Builder costCategoryName​(String costCategoryName)
        Sets the value of the CostCategoryName property for this object.
        Parameters:
        costCategoryName - The new value for the CostCategoryName property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filter

        GetCostCategoriesRequest.Builder filter​(Expression filter)
        Sets the value of the Filter property for this object.
        Parameters:
        filter - The new value for the Filter property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortBy

        GetCostCategoriesRequest.Builder sortBy​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortBy

        GetCostCategoriesRequest.Builder sortBy​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortBy

        GetCostCategoriesRequest.Builder sortBy​(Consumer<SortDefinition.Builder>... 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.

        This is a convenience method that creates an instance of the SortDefinition.Builder avoiding the need to create one manually via SortDefinition.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sortBy(List).

        Parameters:
        sortBy - a consumer that will call methods on SortDefinition.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #sortBy(java.util.Collection)

      • maxResults

        GetCostCategoriesRequest.Builder maxResults​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • nextPageToken

        GetCostCategoriesRequest.Builder nextPageToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.