Package software.amazon.awssdk.services.snowball.model

Class UpdateClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.snowball.model.SnowballRequest

software.amazon.awssdk.services.snowball.model.UpdateClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	addressId()	The ID of the updated Address object.
static UpdateClusterRequest.Builder	builder()
String	clusterId()	The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.
String	description()	The updated description of this cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forwardingAddressId()	The updated ID for the forwarding address for a cluster.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Notification	notification()	The new or updated Notification object.
OnDeviceServiceConfiguration	onDeviceServiceConfiguration()	Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.
JobResource	resources()	The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
String	roleARN()	The new role Amazon Resource Name (ARN) that you want to associate with this cluster.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateClusterRequest.Builder>	serializableBuilderClass()
ShippingOption	shippingOption()	The updated shipping option value of this cluster's ShippingDetails object.
String	shippingOptionAsString()	The updated shipping option value of this cluster's ShippingDetails object.
UpdateClusterRequest.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

clusterId

public final String clusterId()

The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

Returns:

The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

roleARN

public final String roleARN()

The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in Identity and Access Management (IAM).

Returns:

The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in Identity and Access Management (IAM).

description

public final String description()

The updated description of this cluster.

Returns:

The updated description of this cluster.

resources

public final JobResource resources()

The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

Returns:

The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

onDeviceServiceConfiguration

public final OnDeviceServiceConfiguration onDeviceServiceConfiguration()

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).

Returns:

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).

addressId

public final String addressId()

The ID of the updated Address object.

Returns:

The ID of the updated Address object.

shippingOption

public final ShippingOption shippingOption()

The updated shipping option value of this cluster's ShippingDetails object.

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

Returns:

The updated shipping option value of this cluster's ShippingDetails object.

See Also:

ShippingOption

shippingOptionAsString

public final String shippingOptionAsString()

The updated shipping option value of this cluster's ShippingDetails object.

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

Returns:

The updated shipping option value of this cluster's ShippingDetails object.

See Also:

ShippingOption

notification

public final Notification notification()

The new or updated Notification object.

Returns:

The new or updated Notification object.

forwardingAddressId

public final String forwardingAddressId()

The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

Returns:

The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

toBuilder

public UpdateClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

Specified by:

toBuilder in class SnowballRequest

builder

public static UpdateClusterRequest.Builder builder()

serializableBuilderClass

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