software.amazon.awssdk.services.costexplorer.model.GetDimensionValuesRequest Maven / Gradle / Ivy
Show all versions of costexplorer Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.costexplorer.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetDimensionValuesRequest extends CostExplorerRequest implements
ToCopyableBuilder {
private static final SdkField SEARCH_STRING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SearchString").getter(getter(GetDimensionValuesRequest::searchString))
.setter(setter(Builder::searchString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SearchString").build()).build();
private static final SdkField TIME_PERIOD_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("TimePeriod").getter(getter(GetDimensionValuesRequest::timePeriod)).setter(setter(Builder::timePeriod))
.constructor(DateInterval::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimePeriod").build()).build();
private static final SdkField DIMENSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Dimension").getter(getter(GetDimensionValuesRequest::dimensionAsString))
.setter(setter(Builder::dimension))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimension").build()).build();
private static final SdkField CONTEXT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Context")
.getter(getter(GetDimensionValuesRequest::contextAsString)).setter(setter(Builder::context))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Context").build()).build();
private static final SdkField NEXT_PAGE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextPageToken").getter(getter(GetDimensionValuesRequest::nextPageToken))
.setter(setter(Builder::nextPageToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextPageToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SEARCH_STRING_FIELD,
TIME_PERIOD_FIELD, DIMENSION_FIELD, CONTEXT_FIELD, NEXT_PAGE_TOKEN_FIELD));
private final String searchString;
private final DateInterval timePeriod;
private final String dimension;
private final String context;
private final String nextPageToken;
private GetDimensionValuesRequest(BuilderImpl builder) {
super(builder);
this.searchString = builder.searchString;
this.timePeriod = builder.timePeriod;
this.dimension = builder.dimension;
this.context = builder.context;
this.nextPageToken = builder.nextPageToken;
}
/**
*
* The value that you want to search the filter values for.
*
*
* @return The value that you want to search the filter values for.
*/
public String searchString() {
return searchString;
}
/**
*
* The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is
* exclusive. For example, if start is 2017-01-01 and end is
* 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
* including 2017-04-30 but not including 2017-05-01.
*
*
* @return The start and end dates for retrieving the dimension values. The start date is inclusive, but the end
* date is exclusive. For example, if start is 2017-01-01 and end is
* 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
* including 2017-04-30 but not including 2017-05-01.
*/
public DateInterval timePeriod() {
return timePeriod;
}
/**
*
* The name of the dimension. Each Dimension is available for a different Context. For
* more information, see Context.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #dimension} will
* return {@link Dimension#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #dimensionAsString}.
*
*
* @return The name of the dimension. Each Dimension is available for a different Context.
* For more information, see Context.
* @see Dimension
*/
public Dimension dimension() {
return Dimension.fromValue(dimension);
}
/**
*
* The name of the dimension. Each Dimension is available for a different Context. For
* more information, see Context.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #dimension} will
* return {@link Dimension#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #dimensionAsString}.
*
*
* @return The name of the dimension. Each Dimension is available for a different Context.
* For more information, see Context.
* @see Dimension
*/
public String dimensionAsString() {
return dimension;
}
/**
*
* The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
* RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the
* resulting dimension values can be used in the GetCostAndUsage operation.
*
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and CreateBucket.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand
* Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
* response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14
* days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability
* Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #context} will
* return {@link Context#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #contextAsString}.
*
*
* @return The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
* RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE,
* the resulting dimension values can be used in the GetCostAndUsage operation.
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for
* searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web
* Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account.
* The value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and CreateBucket
* .
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include
* On-Demand Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
* response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for
* last 14 days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account.
* The value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single
* Availability Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account.
* The value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
* @see Context
*/
public Context context() {
return Context.fromValue(context);
}
/**
*
* The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
* RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the
* resulting dimension values can be used in the GetCostAndUsage operation.
*
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and CreateBucket.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand
* Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
* response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14
* days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability
* Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #context} will
* return {@link Context#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #contextAsString}.
*
*
* @return The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
* RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE,
* the resulting dimension values can be used in the GetCostAndUsage operation.
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for
* searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web
* Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account.
* The value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and CreateBucket
* .
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include
* On-Demand Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
* response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for
* last 14 days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account.
* The value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single
* Availability Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account.
* The value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
* @see Context
*/
public String contextAsString() {
return context;
}
/**
*
* The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
* more results than the maximum page size.
*
*
* @return The token to retrieve the next set of results. AWS provides the token when the response from a previous
* call has more results than the maximum page size.
*/
public String nextPageToken() {
return nextPageToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(searchString());
hashCode = 31 * hashCode + Objects.hashCode(timePeriod());
hashCode = 31 * hashCode + Objects.hashCode(dimensionAsString());
hashCode = 31 * hashCode + Objects.hashCode(contextAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextPageToken());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetDimensionValuesRequest)) {
return false;
}
GetDimensionValuesRequest other = (GetDimensionValuesRequest) obj;
return Objects.equals(searchString(), other.searchString()) && Objects.equals(timePeriod(), other.timePeriod())
&& Objects.equals(dimensionAsString(), other.dimensionAsString())
&& Objects.equals(contextAsString(), other.contextAsString())
&& Objects.equals(nextPageToken(), other.nextPageToken());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("GetDimensionValuesRequest").add("SearchString", searchString()).add("TimePeriod", timePeriod())
.add("Dimension", dimensionAsString()).add("Context", contextAsString()).add("NextPageToken", nextPageToken())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SearchString":
return Optional.ofNullable(clazz.cast(searchString()));
case "TimePeriod":
return Optional.ofNullable(clazz.cast(timePeriod()));
case "Dimension":
return Optional.ofNullable(clazz.cast(dimensionAsString()));
case "Context":
return Optional.ofNullable(clazz.cast(contextAsString()));
case "NextPageToken":
return Optional.ofNullable(clazz.cast(nextPageToken()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetDimensionValuesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The value that you want to search the filter values for.
*
*
* @param searchString
* The value that you want to search the filter values for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchString(String searchString);
/**
*
* The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is
* exclusive. For example, if start is 2017-01-01 and end is
* 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
* including 2017-04-30 but not including 2017-05-01.
*
*
* @param timePeriod
* The start and end dates for retrieving the dimension values. The start date is inclusive, but the end
* date is exclusive. For example, if start is 2017-01-01 and end
* is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up
* to and including 2017-04-30 but not including 2017-05-01.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timePeriod(DateInterval timePeriod);
/**
*
* The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is
* exclusive. For example, if start is 2017-01-01 and end is
* 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
* including 2017-04-30 but not including 2017-05-01.
*
* This is a convenience that creates an instance of the {@link DateInterval.Builder} avoiding the need to
* create one manually via {@link DateInterval#builder()}.
*
* When the {@link Consumer} completes, {@link DateInterval.Builder#build()} is called immediately and its
* result is passed to {@link #timePeriod(DateInterval)}.
*
* @param timePeriod
* a consumer that will call methods on {@link DateInterval.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #timePeriod(DateInterval)
*/
default Builder timePeriod(Consumer timePeriod) {
return timePeriod(DateInterval.builder().applyMutation(timePeriod).build());
}
/**
*
* The name of the dimension. Each Dimension is available for a different Context. For
* more information, see Context.
*
*
* @param dimension
* The name of the dimension. Each Dimension is available for a different
* Context. For more information, see Context.
* @see Dimension
* @return Returns a reference to this object so that method calls can be chained together.
* @see Dimension
*/
Builder dimension(String dimension);
/**
*
* The name of the dimension. Each Dimension is available for a different Context. For
* more information, see Context.
*
*
* @param dimension
* The name of the dimension. Each Dimension is available for a different
* Context. For more information, see Context.
* @see Dimension
* @return Returns a reference to this object so that method calls can be chained together.
* @see Dimension
*/
Builder dimension(Dimension dimension);
/**
*
* The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
* RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the
* resulting dimension values can be used in the GetCostAndUsage operation.
*
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and CreateBucket.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include
* On-Demand Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
* response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last
* 14 days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single
* Availability Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
*
*
* @param context
* The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set
* to RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE
* , the resulting dimension values can be used in the GetCostAndUsage operation.
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for
* searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web
* Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member
* account. The value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and
* CreateBucket.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include
* On-Demand Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms.
* The response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available
* for last 14 days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for
* searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member
* account. The value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single
* Availability Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for
* searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member
* account. The value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
* @see Context
* @return Returns a reference to this object so that method calls can be chained together.
* @see Context
*/
Builder context(String context);
/**
*
* The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
* RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the
* resulting dimension values can be used in the GetCostAndUsage operation.
*
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and CreateBucket.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include
* On-Demand Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
* response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last
* 14 days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single
* Availability Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
* value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
*
*
* @param context
* The context for the call to GetDimensionValues. This can be RESERVATIONS or
* COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set
* to RESERVATIONS, the resulting dimension values can be used in the
* GetReservationUtilization operation. If the context is set to COST_AND_USAGE
* , the resulting dimension values can be used in the GetCostAndUsage operation.
*
* If you set the context to COST_AND_USAGE, you can use the following dimensions for
* searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web
* Services.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member
* account. The value field contains the AWS ID of the member account.
*
*
* -
*
* OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
*
*
* -
*
* OPERATION - The action performed. Examples include RunInstance and
* CreateBucket.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include
* On-Demand Instances and Standard Reserved Instances.
*
*
* -
*
* SERVICE - The AWS service such as Amazon DynamoDB.
*
*
* -
*
* USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
* GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
*
*
* -
*
* USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms.
* The response for this operation includes a unit attribute.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
*
*
* -
*
* RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available
* for last 14 days for EC2-Compute Service.
*
*
*
*
* If you set the context to RESERVATIONS, you can use the following dimensions for
* searching:
*
*
* -
*
* AZ - The Availability Zone. An example is us-east-1a.
*
*
* -
*
* CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
*
*
* -
*
* DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
* SingleAZ and MultiAZ.
*
*
* -
*
* INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member
* account. The value field contains the AWS ID of the member account.
*
*
* -
*
* PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single
* Availability Zone.
*
*
* -
*
* TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
*
*
* -
*
* TENANCY - The tenancy of a resource. Examples are shared or dedicated.
*
*
*
*
* If you set the context to SAVINGS_PLANS, you can use the following dimensions for
* searching:
*
*
* -
*
* SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
*
*
* -
*
* PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*
*
* -
*
* REGION - The AWS Region.
*
*
* -
*
* INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
*
*
* -
*
* LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member
* account. The value field contains the AWS ID of the member account.
*
*
* -
*
* SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
*
*
* @see Context
* @return Returns a reference to this object so that method calls can be chained together.
* @see Context
*/
Builder context(Context context);
/**
*
* The token to retrieve the next set of results. AWS provides the token when the response from a previous call
* has more results than the maximum page size.
*
*
* @param nextPageToken
* The token to retrieve the next set of results. AWS provides the token when the response from a
* previous call has more results than the maximum page size.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextPageToken(String nextPageToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CostExplorerRequest.BuilderImpl implements Builder {
private String searchString;
private DateInterval timePeriod;
private String dimension;
private String context;
private String nextPageToken;
private BuilderImpl() {
}
private BuilderImpl(GetDimensionValuesRequest model) {
super(model);
searchString(model.searchString);
timePeriod(model.timePeriod);
dimension(model.dimension);
context(model.context);
nextPageToken(model.nextPageToken);
}
public final String getSearchString() {
return searchString;
}
@Override
public final Builder searchString(String searchString) {
this.searchString = searchString;
return this;
}
public final void setSearchString(String searchString) {
this.searchString = searchString;
}
public final DateInterval.Builder getTimePeriod() {
return timePeriod != null ? timePeriod.toBuilder() : null;
}
@Override
public final Builder timePeriod(DateInterval timePeriod) {
this.timePeriod = timePeriod;
return this;
}
public final void setTimePeriod(DateInterval.BuilderImpl timePeriod) {
this.timePeriod = timePeriod != null ? timePeriod.build() : null;
}
public final String getDimension() {
return dimension;
}
@Override
public final Builder dimension(String dimension) {
this.dimension = dimension;
return this;
}
@Override
public final Builder dimension(Dimension dimension) {
this.dimension(dimension == null ? null : dimension.toString());
return this;
}
public final void setDimension(String dimension) {
this.dimension = dimension;
}
public final String getContext() {
return context;
}
@Override
public final Builder context(String context) {
this.context = context;
return this;
}
@Override
public final Builder context(Context context) {
this.context(context == null ? null : context.toString());
return this;
}
public final void setContext(String context) {
this.context = context;
}
public final String getNextPageToken() {
return nextPageToken;
}
@Override
public final Builder nextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
return this;
}
public final void setNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetDimensionValuesRequest build() {
return new GetDimensionValuesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}