Class CreatePricingRuleRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

      Returns:
      A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

    • name

      public final String name()

      The pricing rule name. The names must be unique to each pricing rule.

      Returns:
      The pricing rule name. The names must be unique to each pricing rule.

    • description

      public final String description()

      The pricing rule description.

      Returns:
      The pricing rule description.

    • scope

      public final PricingRuleScope scope()

      The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.

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

      Returns:
      The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.
      See Also:

    • scopeAsString

      public final String scopeAsString()

      The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.

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

      Returns:
      The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.
      See Also:

    • type

      public final PricingRuleType type()

      The type of pricing rule.

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

      Returns:
      The type of pricing rule.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of pricing rule.

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

      Returns:
      The type of pricing rule.
      See Also:

    • modifierPercentage

      public final Double modifierPercentage()

      A percentage modifier that's applied on the public pricing rates. Your entry will be rounded to the nearest 2 decimal places.

      Returns:
      A percentage modifier that's applied on the public pricing rates. Your entry will be rounded to the nearest 2 decimal places.

    • service

      public final String service()

      If the Scope attribute is set to SERVICE or SKU, the attribute indicates which service the PricingRule is applicable for.

      Returns:
      If the Scope attribute is set to SERVICE or SKU, the attribute indicates which service the PricingRule is applicable for.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A map that contains tag keys and tag values that are attached to a pricing rule.

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

      Returns:
      A map that contains tag keys and tag values that are attached to a pricing rule.

    • billingEntity

      public final String billingEntity()

      The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

      Returns:
      The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

    • tiering

      public final CreateTieringInput tiering()

      The set of tiering configurations for the pricing rule.

      Returns:
      The set of tiering configurations for the pricing rule.

    • usageType

      public final String usageType()

      Usage type is the unit that each service uses to measure the usage of a specific type of resource.

      If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.

      Returns:
      Usage type is the unit that each service uses to measure the usage of a specific type of resource.

      If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.

    • operation

      public final String operation()

      Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.

      If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

      Returns:
      Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.

      If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

    • toBuilder

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

    • builder

      public static CreatePricingRuleRequest.Builder builder()

    • serializableBuilderClass

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