Class DescribeDatasetImportJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeDatasetImportJobResponse.Builder,
DescribeDatasetImportJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
When the dataset import job was created.final String
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.final String
The ARN of the dataset import job.final String
The name of the dataset import job.final Double
dataSize()
The size of the dataset in gigabytes (GB) after the import job has finished.final DataSource
The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The estimated time remaining in minutes for the dataset import job to complete.final Map
<String, Statistics> Statistical information about each field in the input data.final String
format()
The format of the imported data, CSV or PARQUET.final String
The format of the geolocation attribute.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the FieldStatistics property.final int
hashCode()
final ImportMode
The import mode of the dataset import job, FULL or INCREMENTAL.final String
The import mode of the dataset import job, FULL or INCREMENTAL.final Instant
The last time the resource was modified.final String
message()
If an error occurred, an informational message about the error.static Class
<? extends DescribeDatasetImportJobResponse.Builder> final String
status()
The status of the dataset import job.final String
The format of timestamps in the dataset.final String
timeZone()
The single time zone applied to every item in the datasetTake 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.final Boolean
WhetherTimeZone
is automatically derived from the geolocation attribute.Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
datasetImportJobName
The name of the dataset import job.
- Returns:
- The name of the dataset import job.
-
datasetImportJobArn
The ARN of the dataset import job.
- Returns:
- The ARN of the dataset import job.
-
datasetArn
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
- Returns:
- The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
-
timestampFormat
The format of timestamps in the dataset. The format that you specify depends on the
DataFrequency
specified when the dataset was created. The following formats are supported-
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
-
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
- Returns:
- The format of timestamps in the dataset. The format that you specify depends on the
DataFrequency
specified when the dataset was created. The following formats are supported-
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
-
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
-
-
-
timeZone
The single time zone applied to every item in the dataset
- Returns:
- The single time zone applied to every item in the dataset
-
useGeolocationForTimeZone
Whether
TimeZone
is automatically derived from the geolocation attribute.- Returns:
- Whether
TimeZone
is automatically derived from the geolocation attribute.
-
geolocationFormat
The format of the geolocation attribute. Valid Values:
"LAT_LONG"
and"CC_POSTALCODE"
.- Returns:
- The format of the geolocation attribute. Valid Values:
"LAT_LONG"
and"CC_POSTALCODE"
.
-
dataSource
The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
If encryption is used,
DataSource
includes an Key Management Service (KMS) key.- Returns:
- The location of the training data to import and an Identity and Access Management (IAM) role that Amazon
Forecast can assume to access the data.
If encryption is used,
DataSource
includes an Key Management Service (KMS) key.
-
estimatedTimeRemainingInMinutes
The estimated time remaining in minutes for the dataset import job to complete.
- Returns:
- The estimated time remaining in minutes for the dataset import job to complete.
-
hasFieldStatistics
public final boolean hasFieldStatistics()For responses, this returns true if the service returned a value for the FieldStatistics 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. -
fieldStatistics
Statistical information about each field in the input data.
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
hasFieldStatistics()
method.- Returns:
- Statistical information about each field in the input data.
-
dataSize
The size of the dataset in gigabytes (GB) after the import job has finished.
- Returns:
- The size of the dataset in gigabytes (GB) after the import job has finished.
-
status
The status of the dataset import job. States include:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
- Returns:
- The status of the dataset import job. States include:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
-
-
message
If an error occurred, an informational message about the error.
- Returns:
- If an error occurred, an informational message about the error.
-
creationTime
When the dataset import job was created.
- Returns:
- When the dataset import job was created.
-
lastModificationTime
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
- Returns:
- The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
-
-
-
format
The format of the imported data, CSV or PARQUET.
- Returns:
- The format of the imported data, CSV or PARQUET.
-
importMode
The import mode of the dataset import job, FULL or INCREMENTAL.
If the service returns an enum value that is not available in the current SDK version,
importMode
will returnImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- The import mode of the dataset import job, FULL or INCREMENTAL.
- See Also:
-
importModeAsString
The import mode of the dataset import job, FULL or INCREMENTAL.
If the service returns an enum value that is not available in the current SDK version,
importMode
will returnImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- The import mode of the dataset import job, FULL or INCREMENTAL.
- See Also:
-
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<DescribeDatasetImportJobResponse.Builder,
DescribeDatasetImportJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-