@Generated(value="software.amazon.awssdk:codegen") public final class CreateForecastRequest extends ForecastRequest implements ToCopyableBuilder<CreateForecastRequest.Builder,CreateForecastRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateForecastRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateForecastRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
forecastName()
A name for the forecast.
|
List<String> |
forecastTypes()
The quantiles at which probabilistic forecasts are generated.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasForecastTypes()
For responses, this returns true if the service returned a value for the ForecastTypes property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
predictorArn()
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateForecastRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The optional metadata that you apply to the forecast to help you categorize and organize them.
|
CreateForecastRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String forecastName()
A name for the forecast.
public final String predictorArn()
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
public final boolean hasForecastTypes()
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.public final List<String> forecastTypes()
The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per
forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean.
The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta
and Negative Binomial). The default value is ["0.1", "0.5", "0.9"].
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 hasForecastTypes() method.
0.01 to 0.99 (increments of .01 only)
and mean. The mean forecast is different from the median (0.50) when the distribution is not
symmetric (for example, Beta and Negative Binomial). The default value is
["0.1", "0.5", "0.9"].public final boolean hasTags()
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.public final List<Tag> tags()
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this
prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be
a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not
count against your tags per resource limit.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix.
Values can have this prefix. If a tag value has aws as its prefix but the key does not, then
Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the
key prefix of aws do not count against your tags per resource limit.
public CreateForecastRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateForecastRequest.Builder,CreateForecastRequest>toBuilder in class ForecastRequestpublic static CreateForecastRequest.Builder builder()
public static Class<? extends CreateForecastRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.