Class AsyncInferenceNotificationConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.AsyncInferenceNotificationConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AsyncInferenceNotificationConfig.Builder,AsyncInferenceNotificationConfig>
@Generated("software.amazon.awssdk:codegen") public final class AsyncInferenceNotificationConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AsyncInferenceNotificationConfig.Builder,AsyncInferenceNotificationConfig>

Specifies the configuration for notifications of inference results for asynchronous inference.

See Also:

  • Method Details

    • successTopic

      public final String successTopic()

      Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

      Returns:
      Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

    • errorTopic

      public final String errorTopic()

      Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

      Returns:
      Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

    • includeInferenceResponseIn

      public final List<AsyncNotificationTopicTypes> includeInferenceResponseIn()

      The Amazon SNS topics where you want the inference response to be included.

      The inference response is included only if the response size is less than or equal to 128 KB.

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

      Returns:
      The Amazon SNS topics where you want the inference response to be included.

      The inference response is included only if the response size is less than or equal to 128 KB.

    • hasIncludeInferenceResponseIn

      public final boolean hasIncludeInferenceResponseIn()
      For responses, this returns true if the service returned a value for the IncludeInferenceResponseIn 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.

    • includeInferenceResponseInAsStrings

      public final List<String> includeInferenceResponseInAsStrings()

      The Amazon SNS topics where you want the inference response to be included.

      The inference response is included only if the response size is less than or equal to 128 KB.

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

      Returns:
      The Amazon SNS topics where you want the inference response to be included.

      The inference response is included only if the response size is less than or equal to 128 KB.

    • toBuilder

      public AsyncInferenceNotificationConfig.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<AsyncInferenceNotificationConfig.Builder,AsyncInferenceNotificationConfig>
      Returns:
      a builder for type T

    • builder

      public static AsyncInferenceNotificationConfig.Builder builder()

    • serializableBuilderClass

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