Class DescribeDatasetExportJobResponse

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

Response for describe dataset export job request.

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier for the dataset export job.

      Returns:
      The unique identifier for the dataset export job.

    • workspaceName

      public final String workspaceName()

      The name of the workspace that contains the dataset export job.

      Returns:
      The name of the workspace that contains the dataset export job.

    • status

      public final DatasetExportJobStatus status()

      The current status of the dataset export job.

      If the service returns an enum value that is not available in the current SDK version, status will return DatasetExportJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the dataset export job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the dataset export job.

      If the service returns an enum value that is not available in the current SDK version, status will return DatasetExportJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the dataset export job.
      See Also:

    • startedAt

      public final Instant startedAt()

      The timestamp when the job started processing.

      Returns:
      The timestamp when the job started processing.

    • completedAt

      public final Instant completedAt()

      The timestamp when the job completed, or null if the job is still running.

      Returns:
      The timestamp when the job completed, or null if the job is still running.

    • destinationS3Uri

      public final String destinationS3Uri()

      The S3 URI where output clips are written.

      Returns:
      The S3 URI where output clips are written.

    • errorReportLocation

      public final ExportErrorReportLocation errorReportLocation()

      The location where the error report will be written on failure.

      Returns:
      The location where the error report will be written on failure.

    • input

      public final ProcessingInput input()

      The processing input that was provided in the CreateDatasetExportJob request.

      Returns:
      The processing input that was provided in the CreateDatasetExportJob request.

    • toBuilder

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

    • builder

      public static DescribeDatasetExportJobResponse.Builder builder()

    • serializableBuilderClass

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