software.amazon.awssdk.services.lookoutequipment.model

Class CreateInferenceSchedulerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentRequest

software.amazon.awssdk.services.lookoutequipment.model.CreateInferenceSchedulerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateInferenceSchedulerRequest.Builder,CreateInferenceSchedulerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateInferenceSchedulerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateInferenceSchedulerRequest.Builder	builder()
String	clientToken() A unique identifier for the request.
Long	dataDelayOffsetInMinutes() The interval (in minutes) of planned delay at the start of each inference segment.
InferenceInputConfiguration	dataInputConfiguration() Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
InferenceOutputConfiguration	dataOutputConfiguration() Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
DataUploadFrequency	dataUploadFrequency() How often data is uploaded to the source Amazon S3 bucket for the input data.
String	dataUploadFrequencyAsString() How often data is uploaded to the source Amazon 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()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	inferenceSchedulerName() The name of the inference scheduler being created.
String	modelName() The name of the previously trained ML model being used to create the inference scheduler.
String	roleArn() The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateInferenceSchedulerRequest.Builder>	serializableBuilderClass()
String	serverSideKmsKeyId() Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
List<Tag>	tags() Any tags associated with the inference scheduler.
CreateInferenceSchedulerRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

modelName

public final String modelName()

The name of the previously trained ML model being used to create the inference scheduler.

Returns:

The name of the previously trained ML model being used to create the inference scheduler.

inferenceSchedulerName

public final String inferenceSchedulerName()

The name of the inference scheduler being created.

Returns:

The name of the inference scheduler being created.

dataDelayOffsetInMinutes

public final Long dataDelayOffsetInMinutes()

The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

For more information, see Understanding the inference process.

Returns:

The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

For more information, see Understanding the inference process.

dataUploadFrequency

public final DataUploadFrequency dataUploadFrequency()

How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen 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 runs inference on your data.

For more information, see Understanding the inference process.

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:

How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen 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 runs inference on your data.

For more information, see Understanding the inference process.

See Also:

DataUploadFrequency

dataUploadFrequencyAsString

public final String dataUploadFrequencyAsString()

How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen 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 runs inference on your data.

For more information, see Understanding the inference process.

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:

How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen 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 runs inference on your data.

For more information, see Understanding the inference process.

See Also:

DataUploadFrequency

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 configuration information for the output results for the inference scheduler, including the S3 location for the output.

Returns:

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

roleArn

public final String roleArn()

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

Returns:

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

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.

clientToken

public final String clientToken()

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Returns:

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Any tags associated with the inference scheduler.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Any tags associated with the inference scheduler.

toBuilder

public CreateInferenceSchedulerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateInferenceSchedulerRequest.Builder,CreateInferenceSchedulerRequest>

Specified by:

toBuilder in class LookoutEquipmentRequest

builder

public static CreateInferenceSchedulerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateInferenceSchedulerRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo