Class ListPriceListsRequest

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

  • Method Details

    • serviceCode

      public final String serviceCode()

      The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.

      To retrieve the Reserved Instance and Compute Savings Plan price lists, use ComputeSavingsPlans.

      To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans.

      Returns:
      The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.

      To retrieve the Reserved Instance and Compute Savings Plan price lists, use ComputeSavingsPlans.

      To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans.

    • effectiveDate

      public final Instant effectiveDate()

      The date that the Price List file prices are effective from.

      Returns:
      The date that the Price List file prices are effective from.

    • regionCode

      public final String regionCode()

      This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

      Returns:
      This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

    • currencyCode

      public final String currencyCode()

      The three alphabetical character ISO-4217 currency code that the Price List files are denominated in.

      Returns:
      The three alphabetical character ISO-4217 currency code that the Price List files are denominated in.

    • nextToken

      public final String nextToken()

      The pagination token that indicates the next set of results that you want to retrieve.

      Returns:
      The pagination token that indicates the next set of results that you want to retrieve.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in the response.

      Returns:
      The maximum number of results to return in the response.

    • toBuilder

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

    • builder

      public static ListPriceListsRequest.Builder builder()

    • serializableBuilderClass

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