software.amazon.awssdk.services.forecast.model

Class CreateForecastExportJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.forecast.model.ForecastRequest

software.amazon.awssdk.services.forecast.model.CreateForecastExportJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateForecastExportJobRequest.Builder,CreateForecastExportJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateForecastExportJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateForecastExportJobRequest.Builder	builder()
DataDestination	destination() The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forecastArn() The Amazon Resource Name (ARN) of the forecast that you want to export.
String	forecastExportJobName() The name for the forecast export job.
String	format() The format of the exported data, CSV or PARQUET.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateForecastExportJobRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The optional metadata that you apply to the forecast export job to help you categorize and organize them.
CreateForecastExportJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

forecastExportJobName

public final String forecastExportJobName()

The name for the forecast export job.

Returns:

The name for the forecast export job.

forecastArn

public final String forecastArn()

The Amazon Resource Name (ARN) of the forecast that you want to export.

Returns:

The Amazon Resource Name (ARN) of the forecast that you want to export.

destination

public final DataDestination destination()

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Returns:

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

The optional metadata that you apply to the forecast export job 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 Amazon Web Services 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.

Returns:

The optional metadata that you apply to the forecast export job 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 Amazon Web Services 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.

format

public final String format()

The format of the exported data, CSV or PARQUET. The default value is CSV.

Returns:

The format of the exported data, CSV or PARQUET. The default value is CSV.

toBuilder

public CreateForecastExportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateForecastExportJobRequest.Builder,CreateForecastExportJobRequest>

Specified by:

toBuilder in class ForecastRequest

builder

public static CreateForecastExportJobRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo