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

Class CreateCostCategoryDefinitionRequest

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

  • Method Details

    • name

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

    • effectiveStart

      public final String effectiveStart()

      The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.

      Returns:
      The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.

    • ruleVersion

      public final CostCategoryRuleVersion ruleVersion()
      Returns the value of the RuleVersion property for this object.

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

      Returns:
      The value of the RuleVersion property for this object.
      See Also:

    • ruleVersionAsString

      public final String ruleVersionAsString()
      Returns the value of the RuleVersion property for this object.

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

      Returns:
      The value of the RuleVersion property for this object.
      See Also:

    • hasRules

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

    • rules

      public final List<CostCategoryRule> rules()

      The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.

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

      Returns:
      The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.

    • defaultValue

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

    • hasSplitChargeRules

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

    • splitChargeRules

      public final List<CostCategorySplitChargeRule> splitChargeRules()

      The split charge rules used to allocate your charges between your Cost Category values.

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

      Returns:
      The split charge rules used to allocate your charges between your Cost Category values.

    • hasResourceTags

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

    • resourceTags

      public final List<ResourceTag> resourceTags()

      An optional list of tags to associate with the specified CostCategory . You can use resource tags to control access to your cost category using IAM policies.

      Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

      • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

      • The maximum length of a key is 128 characters

      • The maximum length of a value is 256 characters

      • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-

      • Keys and values are case sensitive

      • Keys and values are trimmed for any leading or trailing whitespaces

      • Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

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

      Returns:
      An optional list of tags to associate with the specified CostCategory . You can use resource tags to control access to your cost category using IAM policies.

      Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

      • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

      • The maximum length of a key is 128 characters

      • The maximum length of a value is 256 characters

      • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-

      • Keys and values are case sensitive

      • Keys and values are trimmed for any leading or trailing whitespaces

      • Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    • toBuilder

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

    • builder

      public static CreateCostCategoryDefinitionRequest.Builder builder()

    • serializableBuilderClass

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