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(value="software.amazon.awssdk:codegen")
public final class DescribeDatasetResponse
extends LookoutEquipmentResponse
implements ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDatasetResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDatasetResponse.Builder	builder()
Instant	createdAt() Specifies the time the dataset was created in Lookout for Equipment.
Instant	dataEndTime() Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.
DataQualitySummary	dataQualitySummary() Gives statistics associated with the given dataset for the latest successful associated ingestion job id.
String	datasetArn() The Amazon Resource Name (ARN) of the dataset being described.
String	datasetName() The name of the dataset being described.
Instant	dataStartTime() Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IngestedFilesSummary	ingestedFilesSummary() IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.
IngestionInputConfiguration	ingestionInputConfiguration() Specifies the S3 location configuration for the data input for the data ingestion job.
Instant	lastUpdatedAt() Specifies the time the dataset was last updated, if it was.
String	roleArn() The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.
String	schema() A JSON description of the data that is in each time series dataset, including names, column names, and data types.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDatasetResponse.Builder>	serializableBuilderClass()
String	serverSideKmsKeyId() Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.
DatasetStatus	status() Indicates the status of the dataset.
String	statusAsString() Indicates the status of the dataset.
DescribeDatasetResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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:

DatasetStatus

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:

DatasetStatus

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.

toBuilder

public DescribeDatasetResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

Overrides:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo