software.amazon.awssdk.services.lookoutequipment.model

Class DescribeDataIngestionJobResponse

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.DescribeDataIngestionJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDataIngestionJobResponse.Builder,DescribeDataIngestionJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDataIngestionJobResponse
extends LookoutEquipmentResponse
implements ToCopyableBuilder<DescribeDataIngestionJobResponse.Builder,DescribeDataIngestionJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDataIngestionJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDataIngestionJobResponse.Builder	builder()
Instant	createdAt() The time at which the data ingestion job was created.
Instant	dataEndTime() Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
DataQualitySummary	dataQualitySummary() Gives statistics about a completed ingestion job.
String	datasetArn() The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.
Instant	dataStartTime() Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failedReason() Specifies the reason for failure when a data ingestion job has failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	ingestedDataSize() Indicates the size of the ingested dataset.
IngestedFilesSummary	ingestedFilesSummary() Returns the value of the IngestedFilesSummary property for this object.
IngestionInputConfiguration	ingestionInputConfiguration() Specifies the S3 location configuration for the data input for the data ingestion job.
String	jobId() Indicates the job ID of the data ingestion job.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDataIngestionJobResponse.Builder>	serializableBuilderClass()
IngestionJobStatus	status() Indicates the status of the DataIngestionJob operation.
String	statusAsString() Indicates the status of the DataIngestionJob operation.
String	statusDetail() Provides details about status of the ingestion job that is currently in progress.
DescribeDataIngestionJobResponse.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

jobId

public final String jobId()

Indicates the job ID of the data ingestion job.

Returns:

Indicates the job ID of the data ingestion job.

datasetArn

public final String datasetArn()

The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

Returns:

The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

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.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

Returns:

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

createdAt

public final Instant createdAt()

The time at which the data ingestion job was created.

Returns:

The time at which the data ingestion job was created.

status

public final IngestionJobStatus status()

Indicates the status of the DataIngestionJob operation.

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

Returns:

Indicates the status of the DataIngestionJob operation.

See Also:

IngestionJobStatus

statusAsString

public final String statusAsString()

Indicates the status of the DataIngestionJob operation.

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

Returns:

Indicates the status of the DataIngestionJob operation.

See Also:

IngestionJobStatus

failedReason

public final String failedReason()

Specifies the reason for failure when a data ingestion job has failed.

Returns:

Specifies the reason for failure when a data ingestion job has failed.

dataQualitySummary

public final DataQualitySummary dataQualitySummary()

Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

Returns:

Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

ingestedFilesSummary

public final IngestedFilesSummary ingestedFilesSummary()

Returns the value of the IngestedFilesSummary property for this object.

Returns:

The value of the IngestedFilesSummary property for this object.

statusDetail

public final String statusDetail()

Provides details about status of the ingestion job that is currently in progress.

Returns:

Provides details about status of the ingestion job that is currently in progress.

ingestedDataSize

public final Long ingestedDataSize()

Indicates the size of the ingested dataset.

Returns:

Indicates the size of the ingested dataset.

dataStartTime

public final Instant dataStartTime()

Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

Returns:

Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

dataEndTime

public final Instant dataEndTime()

Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

Returns:

Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

toBuilder

public DescribeDataIngestionJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDataIngestionJobResponse.Builder,DescribeDataIngestionJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDataIngestionJobResponse.Builder builder()

serializableBuilderClass

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