Package software.amazon.awssdk.services.lookoutequipment.model

Class DescribeDatasetResponse

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

  • Method Details

    • datasetName

      public final String datasetName()

      The name of the dataset being described.

      Returns:
      The name of the dataset being described.

    • datasetArn

      public final String datasetArn()

      The Amazon Resource Name (ARN) of the dataset being described.

      Returns:
      The Amazon Resource Name (ARN) of the dataset being described.

    • createdAt

      public final Instant createdAt()

      Specifies the time the dataset was created in Lookout for Equipment.

      Returns:
      Specifies the time the dataset was created in Lookout for Equipment.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      Specifies the time the dataset was last updated, if it was.

      Returns:
      Specifies the time the dataset was last updated, if it was.

    • status

      public final DatasetStatus status()

      Indicates the status of the dataset.

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

      Returns:
      Indicates the status of the dataset.
      See Also:

    • statusAsString

      public final String statusAsString()

      Indicates the status of the dataset.

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

      Returns:
      Indicates the status of the dataset.
      See Also:

    • schema

      public final String schema()

      A JSON description of the data that is in each time series dataset, including names, column names, and data types.

      Returns:
      A JSON description of the data that is in each time series dataset, including names, column names, and data types.

    • serverSideKmsKeyId

      public final String serverSideKmsKeyId()

      Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

      Returns:
      Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

    • ingestionInputConfiguration

      public final IngestionInputConfiguration ingestionInputConfiguration()

      Specifies the S3 location configuration for the data input for the data ingestion job.

      Returns:
      Specifies the S3 location configuration for the data input for the data ingestion job.

    • dataQualitySummary

      public final DataQualitySummary dataQualitySummary()

      Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

      Returns:
      Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

    • ingestedFilesSummary

      public final IngestedFilesSummary ingestedFilesSummary()

      IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

      Returns:
      IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

    • dataStartTime

      public final Instant dataStartTime()

      Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

      Returns:
      Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

    • dataEndTime

      public final Instant dataEndTime()

      Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

      Returns:
      Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

    • sourceDatasetArn

      public final String sourceDatasetArn()

      The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

      Returns:
      The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

    • toBuilder

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

    • builder

      public static DescribeDatasetResponse.Builder builder()

    • serializableBuilderClass

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