software.amazon.awssdk.services.lookoutequipment.model

Class DescribeInferenceSchedulerResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInferenceSchedulerResponse.Builder,DescribeInferenceSchedulerResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeInferenceSchedulerResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeInferenceSchedulerResponse.Builder	builder()
Instant	createdAt() Specifies the time at which the inference scheduler was created.
Long	dataDelayOffsetInMinutes() A period of time (in minutes) by which inference on the data is delayed after the data starts.
InferenceInputConfiguration	dataInputConfiguration() Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
InferenceOutputConfiguration	dataOutputConfiguration() Specifies information for the output results for the inference scheduler, including the output S3 location.
DataUploadFrequency	dataUploadFrequency() Specifies how often data is uploaded to the source S3 bucket for the input data.
String	dataUploadFrequencyAsString() Specifies how often data is uploaded to the source S3 bucket for the input data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	inferenceSchedulerArn() The Amazon Resource Name (ARN) of the inference scheduler being described.
String	inferenceSchedulerName() The name of the inference scheduler being described.
LatestInferenceResult	latestInferenceResult() Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).
String	latestInferenceResultAsString() Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).
String	modelArn() The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.
String	modelName() The name of the ML model of the inference scheduler being described.
String	roleArn() The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInferenceSchedulerResponse.Builder>	serializableBuilderClass()
String	serverSideKmsKeyId() Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
InferenceSchedulerStatus	status() Indicates the status of the inference scheduler.
String	statusAsString() Indicates the status of the inference scheduler.
DescribeInferenceSchedulerResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() Specifies the time at which the inference scheduler was last updated, if it was.

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

modelArn

public final String modelArn()

The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

Returns:

The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

modelName

public final String modelName()

The name of the ML model of the inference scheduler being described.

Returns:

The name of the ML model of the inference scheduler being described.

inferenceSchedulerName

public final String inferenceSchedulerName()

The name of the inference scheduler being described.

Returns:

The name of the inference scheduler being described.

inferenceSchedulerArn

public final String inferenceSchedulerArn()

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

Returns:

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

status

public final InferenceSchedulerStatus status()

Indicates the status of the inference scheduler.

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

Returns:

Indicates the status of the inference scheduler.

See Also:

InferenceSchedulerStatus

statusAsString

public final String statusAsString()

Indicates the status of the inference scheduler.

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

Returns:

Indicates the status of the inference scheduler.

See Also:

InferenceSchedulerStatus

dataDelayOffsetInMinutes

public final Long dataDelayOffsetInMinutes()

A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

Returns:

A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

dataUploadFrequency

public final DataUploadFrequency dataUploadFrequency()

Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

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

Returns:

Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

See Also:

DataUploadFrequency

dataUploadFrequencyAsString

public final String dataUploadFrequencyAsString()

Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

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

Returns:

Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

See Also:

DataUploadFrequency

createdAt

public final Instant createdAt()

Specifies the time at which the inference scheduler was created.

Returns:

Specifies the time at which the inference scheduler was created.

updatedAt

public final Instant updatedAt()

Specifies the time at which the inference scheduler was last updated, if it was.

Returns:

Specifies the time at which the inference scheduler was last updated, if it was.

dataInputConfiguration

public final InferenceInputConfiguration dataInputConfiguration()

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

Returns:

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

dataOutputConfiguration

public final InferenceOutputConfiguration dataOutputConfiguration()

Specifies information for the output results for the inference scheduler, including the output S3 location.

Returns:

Specifies information for the output results for the inference scheduler, including the output S3 location.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

Returns:

The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

serverSideKmsKeyId

public final String serverSideKmsKeyId()

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

Returns:

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

latestInferenceResult

public final LatestInferenceResult latestInferenceResult()

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

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

Returns:

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

See Also:

LatestInferenceResult

latestInferenceResultAsString

public final String latestInferenceResultAsString()

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

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

Returns:

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

See Also:

LatestInferenceResult

toBuilder

public DescribeInferenceSchedulerResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInferenceSchedulerResponse.Builder,DescribeInferenceSchedulerResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeInferenceSchedulerResponse.Builder builder()

serializableBuilderClass

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