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

Class DescribeSnapshotScheduleResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

software.amazon.awssdk.services.storagegateway.model.DescribeSnapshotScheduleResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSnapshotScheduleResponse.Builder,DescribeSnapshotScheduleResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSnapshotScheduleResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeSnapshotScheduleResponse.Builder	builder()
String	description()	The snapshot 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()	The number of hours between snapshots.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSnapshotScheduleResponse.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 assigned to the snapshot schedule, sorted alphabetically by key name.
String	timezone()	A value that indicates the time zone of the gateway.
DescribeSnapshotScheduleResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeARN()	The Amazon Resource Name (ARN) of the volume that was specified in the request.

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 that was specified in the request.

Returns:

The Amazon Resource Name (ARN) of the volume that was specified in the request.

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

The number of hours between snapshots.

Returns:

The number of hours between snapshots.

description

public final String description()

The snapshot description.

Returns:

The snapshot description.

timezone

public final String timezone()

A value that indicates the time zone of the gateway.

Returns:

A value that indicates the time zone of the gateway.

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 assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

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 assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

toBuilder

public DescribeSnapshotScheduleResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSnapshotScheduleResponse.Builder,DescribeSnapshotScheduleResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeSnapshotScheduleResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo