Package software.amazon.awssdk.services.storagegateway.model

Class UpdateSnapshotScheduleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.UpdateSnapshotScheduleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateSnapshotScheduleRequest.Builder,UpdateSnapshotScheduleRequest>

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

A JSON object containing one or more of the following fields:

• UpdateSnapshotScheduleInput$Description

• UpdateSnapshotScheduleInput$RecurrenceInHours

• UpdateSnapshotScheduleInput$StartAt

• UpdateSnapshotScheduleInput$VolumeARN

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateSnapshotScheduleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateSnapshotScheduleRequest.Builder	builder()
String	description()	Optional description of the snapshot that overwrites the existing description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Integer	recurrenceInHours()	Frequency of snapshots.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateSnapshotScheduleRequest.Builder>	serializableBuilderClass()
Integer	startAt()	The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23).
List<Tag>	tags()	A list of up to 50 tags that can be assigned to a snapshot.
UpdateSnapshotScheduleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeARN()	The Amazon Resource Name (ARN) of the volume.

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

volumeARN

public final String volumeARN()

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns:

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

startAt

public final Integer startAt()

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Returns:

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

recurrenceInHours

public final Integer recurrenceInHours()

Frequency of snapshots. Specify the number of hours between snapshots.

Returns:

Frequency of snapshots. Specify the number of hours between snapshots.

description

public final String description()

Optional description of the snapshot that overwrites the existing description.

Returns:

Optional description of the snapshot that overwrites the existing description.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

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

Returns:

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

toBuilder

public UpdateSnapshotScheduleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateSnapshotScheduleRequest.Builder,UpdateSnapshotScheduleRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static UpdateSnapshotScheduleRequest.Builder builder()

serializableBuilderClass

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