GetDimensionValuesRequest (AWS SDK for Java

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.GetDimensionValuesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDimensionValuesRequest
extends CostExplorerRequest
implements ToCopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetDimensionValuesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetDimensionValuesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetDimensionValuesRequest.Builder`	`builder()`
`Context`	`context()` The context for the call to `GetDimensionValues`.
`String`	`contextAsString()` The context for the call to `GetDimensionValues`.
`Dimension`	`dimension()` The name of the dimension.
`String`	`dimensionAsString()` The name of the dimension.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`nextPageToken()` The token to retrieve the next set of results.
`List<SdkField<?>>`	`sdkFields()`
`String`	`searchString()` The value that you want to search the filter values for.
`static Class<? extends GetDimensionValuesRequest.Builder>`	`serializableBuilderClass()`
`DateInterval`	`timePeriod()` The start and end dates for retrieving the dimension values.
`GetDimensionValuesRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - searchString
```
public String searchString()
```
    The value that you want to search the filter values for.
    
    Returns:
    
    The value that you want to search the filter values for.
  - timePeriod
```
public 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.
    
    Returns:
    
    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.
  - dimension
```
public Dimension dimension()
```
    The name of the dimension. Each Dimension is available for different a Context. For more information, see Context.
    
    If the service returns an enum value that is not available in the current SDK version, dimension will return Dimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dimensionAsString().
    
    Returns:
    
    The name of the dimension. Each Dimension is available for different a Context. For more information, see Context.
    
    See Also:
    
    Dimension
  - dimensionAsString
```
public String dimensionAsString()
```
    The name of the dimension. Each Dimension is available for different a Context. For more information, see Context.
    
    If the service returns an enum value that is not available in the current SDK version, dimension will return Dimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dimensionAsString().
    
    Returns:
    
    The name of the dimension. Each Dimension is available for different a Context. For more information, see Context.
    
    See Also:
    
    Dimension
  - context
```
public Context 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 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 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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
    - RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
    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 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 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 the service returns an enum value that is not available in the current SDK version, context will return Context.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contextAsString().
    Returns:
    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 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 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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
    
    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
    
    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 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 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.
    See Also:
    
    Context
  - contextAsString
```
public String contextAsString()
```
    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 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 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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
    - RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
    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 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 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 the service returns an enum value that is not available in the current SDK version, context will return Context.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contextAsString().
    Returns:
    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 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 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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
    
    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
    
    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 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 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.
    See Also:
    
    Context
  - nextPageToken
```
public String 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.
    
    Returns:
    
    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.
  - toBuilder
```
public GetDimensionValuesRequest.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<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>
    
    Specified by:
    
    toBuilder in class CostExplorerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetDimensionValuesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDimensionValuesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class GetDimensionValuesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

searchString

timePeriod

dimension

dimensionAsString

context

contextAsString

nextPageToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields