Class GetCostForecastRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetCostForecastRequest.Builder,
GetCostForecastRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Expression
filter()
The filters that you want to use to filter your forecast.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final Granularity
How granular you want the forecast to be.final String
How granular you want the forecast to be.final int
hashCode()
final Metric
metric()
Which metric Cost Explorer uses to create your forecast.final String
Which metric Cost Explorer uses to create your forecast.final Integer
Cost Explorer always returns the mean forecast as a single point.static Class
<? extends GetCostForecastRequest.Builder> final DateInterval
The period of time that you want the forecast to cover.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
timePeriod
The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.
- Returns:
- The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.
-
metric
Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.
Valid values for a
GetCostForecast
call are the following:-
AMORTIZED_COST
-
BLENDED_COST
-
NET_AMORTIZED_COST
-
NET_UNBLENDED_COST
-
UNBLENDED_COST
If the service returns an enum value that is not available in the current SDK version,
metric
will returnMetric.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricAsString()
.- Returns:
- Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended
rates, see Why does
the "blended" annotation appear on some line items in my bill?.
Valid values for a
GetCostForecast
call are the following:-
AMORTIZED_COST
-
BLENDED_COST
-
NET_AMORTIZED_COST
-
NET_UNBLENDED_COST
-
UNBLENDED_COST
-
- See Also:
-
-
metricAsString
Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.
Valid values for a
GetCostForecast
call are the following:-
AMORTIZED_COST
-
BLENDED_COST
-
NET_AMORTIZED_COST
-
NET_UNBLENDED_COST
-
UNBLENDED_COST
If the service returns an enum value that is not available in the current SDK version,
metric
will returnMetric.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricAsString()
.- Returns:
- Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended
rates, see Why does
the "blended" annotation appear on some line items in my bill?.
Valid values for a
GetCostForecast
call are the following:-
AMORTIZED_COST
-
BLENDED_COST
-
NET_AMORTIZED_COST
-
NET_UNBLENDED_COST
-
UNBLENDED_COST
-
- See Also:
-
-
granularity
How granular you want the forecast to be. You can get 3 months of
DAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetCostForecast
operation supports onlyDAILY
andMONTHLY
granularities.If the service returns an enum value that is not available in the current SDK version,
granularity
will returnGranularity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgranularityAsString()
.- Returns:
- How granular you want the forecast to be. You can get 3 months of
DAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetCostForecast
operation supports onlyDAILY
andMONTHLY
granularities. - See Also:
-
granularityAsString
How granular you want the forecast to be. You can get 3 months of
DAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetCostForecast
operation supports onlyDAILY
andMONTHLY
granularities.If the service returns an enum value that is not available in the current SDK version,
granularity
will returnGranularity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgranularityAsString()
.- Returns:
- How granular you want the forecast to be. You can get 3 months of
DAILY
forecasts or 12 months ofMONTHLY
forecasts.The
GetCostForecast
operation supports onlyDAILY
andMONTHLY
granularities. - See Also:
-
filter
The filters that you want to use to filter your forecast. The
GetCostForecast
API supports filtering by the following dimensions:-
AZ
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
LINKED_ACCOUNT_NAME
-
OPERATION
-
PURCHASE_TYPE
-
REGION
-
SERVICE
-
USAGE_TYPE
-
USAGE_TYPE_GROUP
-
RECORD_TYPE
-
OPERATING_SYSTEM
-
TENANCY
-
SCOPE
-
PLATFORM
-
SUBSCRIPTION_ID
-
LEGAL_ENTITY_NAME
-
DEPLOYMENT_OPTION
-
DATABASE_ENGINE
-
INSTANCE_TYPE_FAMILY
-
BILLING_ENTITY
-
RESERVATION_ID
-
SAVINGS_PLAN_ARN
- Returns:
- The filters that you want to use to filter your forecast. The
GetCostForecast
API supports filtering by the following dimensions:-
AZ
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
LINKED_ACCOUNT_NAME
-
OPERATION
-
PURCHASE_TYPE
-
REGION
-
SERVICE
-
USAGE_TYPE
-
USAGE_TYPE_GROUP
-
RECORD_TYPE
-
OPERATING_SYSTEM
-
TENANCY
-
SCOPE
-
PLATFORM
-
SUBSCRIPTION_ID
-
LEGAL_ENTITY_NAME
-
DEPLOYMENT_OPTION
-
DATABASE_ENGINE
-
INSTANCE_TYPE_FAMILY
-
BILLING_ENTITY
-
RESERVATION_ID
-
SAVINGS_PLAN_ARN
-
-
-
predictionIntervalLevel
Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
- Returns:
- Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
-
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 interfaceToCopyableBuilder<GetCostForecastRequest.Builder,
GetCostForecastRequest> - Specified by:
toBuilder
in classCostExplorerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-