Class RecommendationJobStoppingConditions

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.RecommendationJobStoppingConditions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecommendationJobStoppingConditions.Builder,RecommendationJobStoppingConditions>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public RecommendationJobStoppingConditions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RecommendationJobStoppingConditions.Builder,RecommendationJobStoppingConditions>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.