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:

ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateClusterRequest.Builder

Method Summary

Modifier and Type	Method and 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)
String	forwardingAddressId() The updated ID for the forwarding address for a cluster.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Notification	notification() The new or updated Notification object.
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clusterId

public 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 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 AWS 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 AWS Identity and Access Management (IAM).

description

public String description()

The updated description of this cluster.

Returns:

The updated description of this cluster.

resources

public 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.

addressId

public String addressId()

The ID of the updated Address object.

Returns:

The ID of the updated Address object.

shippingOption

public 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 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 Notification notification()

The new or updated Notification object.

Returns:

The new or updated Notification object.

forwardingAddressId

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

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<UpdateClusterRequest.Builder,UpdateClusterRequest>

Specified by:

toBuilder in class SnowballRequest

Returns:

a builder for type T

builder

public static UpdateClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateClusterRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value