Package software.amazon.awssdk.services.sagemaker.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AsyncInferenceNotificationConfig.Builder

Method Summary

Modifier and Type	Method	Description
static AsyncInferenceNotificationConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorTopic()	Amazon SNS topic to post a notification to when inference fails.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIncludeInferenceResponseIn()	For responses, this returns true if the service returned a value for the IncludeInferenceResponseIn property.
List<AsyncNotificationTopicTypes>	includeInferenceResponseIn()	The Amazon SNS topics where you want the inference response to be included.
List<String>	includeInferenceResponseInAsStrings()	The Amazon SNS topics where you want the inference response to be included.
List<SdkField<?>>	sdkFields()
static Class<? extends AsyncInferenceNotificationConfig.Builder>	serializableBuilderClass()
String	successTopic()	Amazon SNS topic to post a notification to when inference completes successfully.
AsyncInferenceNotificationConfig.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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AsyncInferenceNotificationConfig.Builder,AsyncInferenceNotificationConfig>

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)

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