Class DescribeDatasetImportJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.forecast.model.ForecastResponse
software.amazon.awssdk.services.forecast.model.DescribeDatasetImportJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDatasetImportJobResponse.Builder,DescribeDatasetImportJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDatasetImportJobResponse extends ForecastResponse implements ToCopyableBuilder<DescribeDatasetImportJobResponse.Builder,DescribeDatasetImportJobResponse>

  • Method Details

    • datasetImportJobName

      public final String datasetImportJobName()

      The name of the dataset import job.

      Returns:
      The name of the dataset import job.

    • datasetImportJobArn

      public final String datasetImportJobArn()

      The ARN of the dataset import job.

      Returns:
      The ARN of the dataset import job.

    • datasetArn

      public final String 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

      public final String 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

      public final String 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

      public final Boolean useGeolocationForTimeZone()

      Whether TimeZone is automatically derived from the geolocation attribute.

      Returns:
      Whether TimeZone is automatically derived from the geolocation attribute.

    • geolocationFormat

      public final String 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

      public final DataSource 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

      public final Long 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 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.

    • fieldStatistics

      public final Map<String,Statistics> 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

      public final Double 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

      public final String 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

      public final String message()

      If an error occurred, an informational message about the error.

      Returns:
      If an error occurred, an informational message about the error.

    • creationTime

      public final Instant creationTime()

      When the dataset import job was created.

      Returns:
      When the dataset import job was created.

    • lastModificationTime

      public final Instant lastModificationTime()

      The last time the resource was modified. The timestamp depends on the status of the job:

      • CREATE_PENDING - The CreationTime.

      • CREATE_IN_PROGRESS - The current timestamp.

      • CREATE_STOPPING - The current timestamp.

      • CREATE_STOPPED - When the job stopped.

      • ACTIVE or CREATE_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 - The CreationTime.

      • CREATE_IN_PROGRESS - The current timestamp.

      • CREATE_STOPPING - The current timestamp.

      • CREATE_STOPPED - When the job stopped.

      • ACTIVE or CREATE_FAILED - When the job finished or failed.

    • format

      public final String format()

      The format of the imported data, CSV or PARQUET.

      Returns:
      The format of the imported data, CSV or PARQUET.

    • importMode

      public final ImportMode 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 return ImportMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from importModeAsString().

      Returns:
      The import mode of the dataset import job, FULL or INCREMENTAL.
      See Also:

    • importModeAsString

      public final String 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 return ImportMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from importModeAsString().

      Returns:
      The import mode of the dataset import job, FULL or INCREMENTAL.
      See Also:

    • toBuilder

      public DescribeDatasetImportJobResponse.Builder 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 interface ToCopyableBuilder<DescribeDatasetImportJobResponse.Builder,DescribeDatasetImportJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeDatasetImportJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDatasetImportJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.