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

Class UpdateEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.UpdateEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateEndpointRequest.Builder,UpdateEndpointRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateEndpointRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateEndpointRequest.Builder	builder()
DeploymentConfig	deploymentConfig()	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
String	endpointConfigName()	The name of the new endpoint configuration.
String	endpointName()	The name of the endpoint whose configuration you want to update.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<VariantProperty>	excludeRetainedVariantProperties()	When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludeRetainedVariantProperties()	For responses, this returns true if the service returned a value for the ExcludeRetainedVariantProperties property.
int	hashCode()
Boolean	retainAllVariantProperties()	When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
Boolean	retainDeploymentConfig()	Specifies whether to reuse the last deployment configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateEndpointRequest.Builder>	serializableBuilderClass()
UpdateEndpointRequest.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

endpointName

public final String endpointName()

The name of the endpoint whose configuration you want to update.

Returns:

The name of the endpoint whose configuration you want to update.

endpointConfigName

public final String endpointConfigName()

The name of the new endpoint configuration.

Returns:

The name of the new endpoint configuration.

retainAllVariantProperties

public final Boolean retainAllVariantProperties()

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

Returns:

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

hasExcludeRetainedVariantProperties

public final boolean hasExcludeRetainedVariantProperties()

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

excludeRetainedVariantProperties

public final List<VariantProperty> excludeRetainedVariantProperties()

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

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

Returns:

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

deploymentConfig

public final DeploymentConfig deploymentConfig()

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

Returns:

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

retainDeploymentConfig

public final Boolean retainDeploymentConfig()

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

Returns:

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

toBuilder

public UpdateEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEndpointRequest.Builder,UpdateEndpointRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static UpdateEndpointRequest.Builder builder()

serializableBuilderClass

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