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(value="software.amazon.awssdk:codegen")
public final class DescribeSnapshotScheduleResponse
extends StorageGatewayResponse
implements ToCopyableBuilder<DescribeSnapshotScheduleResponse.Builder,DescribeSnapshotScheduleResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSnapshotScheduleResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeSnapshotScheduleResponse.Builder	builder()
String	description() The snapshot description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

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

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.