Package software.amazon.awssdk.services.lookoutvision.model

Class StartModelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lookoutvision.model.LookoutVisionRequest

software.amazon.awssdk.services.lookoutvision.model.StartModelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartModelRequest.Builder,StartModelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartModelRequest
extends LookoutVisionRequest
implements ToCopyableBuilder<StartModelRequest.Builder,StartModelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartModelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartModelRequest.Builder	builder()
String	clientToken()	ClientToken is an idempotency token that ensures a call to StartModel completes only once.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxInferenceUnits()	The maximum number of inference units to use for auto-scaling the model.
Integer	minInferenceUnits()	The minimum number of inference units to use.
String	modelVersion()	The version of the model that you want to start.
String	projectName()	The name of the project that contains the model that you want to start.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartModelRequest.Builder>	serializableBuilderClass()
StartModelRequest.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

projectName

public final String projectName()

The name of the project that contains the model that you want to start.

Returns:

The name of the project that contains the model that you want to start.

modelVersion

public final String modelVersion()

The version of the model that you want to start.

Returns:

The version of the model that you want to start.

minInferenceUnits

public final Integer minInferenceUnits()

The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Returns:

The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

clientToken

public final String clientToken()

ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModel. In this case, safely retry your call to StartModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple start requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModel. An idempotency token is active for 8 hours.

Returns:

ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModel. In this case, safely retry your call to StartModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple start requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModel. An idempotency token is active for 8 hours.

maxInferenceUnits

public final Integer maxInferenceUnits()

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.

Returns:

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.

toBuilder

public StartModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartModelRequest.Builder,StartModelRequest>

Specified by:

toBuilder in class LookoutVisionRequest

builder

public static StartModelRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo