Class CreatePredictorBacktestExportJobRequest
- 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.CreatePredictorBacktestExportJobRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreatePredictorBacktestExportJobRequest.Builder,CreatePredictorBacktestExportJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePredictorBacktestExportJobRequest extends ForecastRequest implements ToCopyableBuilder<CreatePredictorBacktestExportJobRequest.Builder,CreatePredictorBacktestExportJobRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreatePredictorBacktestExportJobRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreatePredictorBacktestExportJobRequest.Builderbuilder()DataDestinationdestination()Returns the value of the Destination property for this object.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringformat()The format of the exported data, CSV or PARQUET.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringpredictorArn()The Amazon Resource Name (ARN) of the predictor that you want to export.StringpredictorBacktestExportJobName()The name for the backtest export job.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreatePredictorBacktestExportJobRequest.Builder>serializableBuilderClass()List<Tag>tags()Optional metadata to help you categorize and organize your backtests.CreatePredictorBacktestExportJobRequest.BuildertoBuilder()StringtoString()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
-
predictorBacktestExportJobName
public final String predictorBacktestExportJobName()
The name for the backtest export job.
- Returns:
- The name for the backtest export job.
-
predictorArn
public final String predictorArn()
The Amazon Resource Name (ARN) of the predictor that you want to export.
- Returns:
- The Amazon Resource Name (ARN) of the predictor that you want to export.
-
destination
public final DataDestination destination()
Returns the value of the Destination property for this object.- Returns:
- The value of the Destination property for this object.
-
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 theisEmpty()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()
Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
-
For each resource, each tag key must be unique and each tag key must have one value.
-
Maximum number of tags per resource: 50.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
-
Key prefixes cannot include any upper or lowercase combination of
aws:orAWS:. Values can have this prefix. If a tag value hasawsas its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofawsdo not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
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:
- Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an
optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
-
For each resource, each tag key must be unique and each tag key must have one value.
-
Maximum number of tags per resource: 50.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
-
Key prefixes cannot include any upper or lowercase combination of
aws:orAWS:. Values can have this prefix. If a tag value hasawsas its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofawsdo not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
-
-
-
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 CreatePredictorBacktestExportJobRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreatePredictorBacktestExportJobRequest.Builder,CreatePredictorBacktestExportJobRequest>- Specified by:
toBuilderin classForecastRequest
-
builder
public static CreatePredictorBacktestExportJobRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreatePredictorBacktestExportJobRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-