software.amazon.awssdk.services.sagemaker.model

Class RecommendationJobStoppingConditions

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.RecommendationJobStoppingConditions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecommendationJobStoppingConditions.Builder,RecommendationJobStoppingConditions>

@Generated(value="software.amazon.awssdk:codegen")
public final class RecommendationJobStoppingConditions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecommendationJobStoppingConditions.Builder,RecommendationJobStoppingConditions>

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecommendationJobStoppingConditions.Builder

Method Summary

Modifier and Type	Method and Description
static RecommendationJobStoppingConditions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FlatInvocations	flatInvocations() Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity.
String	flatInvocationsAsString() Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasModelLatencyThresholds() For responses, this returns true if the service returned a value for the ModelLatencyThresholds property.
Integer	maxInvocations() The maximum number of requests per minute expected for the endpoint.
List<ModelLatencyThreshold>	modelLatencyThresholds() The interval of time taken by a model to respond as viewed from SageMaker.
List<SdkField<?>>	sdkFields()
static Class<? extends RecommendationJobStoppingConditions.Builder>	serializableBuilderClass()
RecommendationJobStoppingConditions.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

maxInvocations

public final Integer maxInvocations()

The maximum number of requests per minute expected for the endpoint.

Returns:

The maximum number of requests per minute expected for the endpoint.

hasModelLatencyThresholds

public final boolean hasModelLatencyThresholds()

For responses, this returns true if the service returned a value for the ModelLatencyThresholds 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.

modelLatencyThresholds

public final List<ModelLatencyThreshold> modelLatencyThresholds()

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

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 hasModelLatencyThresholds() method.

Returns:

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

flatInvocations

public final FlatInvocations flatInvocations()

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

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

Returns:

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

See Also:

FlatInvocations

flatInvocationsAsString

public final String flatInvocationsAsString()

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

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

Returns:

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

See Also:

FlatInvocations

toBuilder

public RecommendationJobStoppingConditions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecommendationJobStoppingConditions.Builder,RecommendationJobStoppingConditions>

builder

public static RecommendationJobStoppingConditions.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo