software.amazon.awssdk.services.storagegateway.model.DescribeSnapshotScheduleResponse Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.storagegateway.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeSnapshotScheduleResponse extends StorageGatewayResponse implements
ToCopyableBuilder {
private static final SdkField VOLUME_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VolumeARN").getter(getter(DescribeSnapshotScheduleResponse::volumeARN))
.setter(setter(Builder::volumeARN))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VolumeARN").build()).build();
private static final SdkField START_AT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("StartAt").getter(getter(DescribeSnapshotScheduleResponse::startAt)).setter(setter(Builder::startAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartAt").build()).build();
private static final SdkField RECURRENCE_IN_HOURS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("RecurrenceInHours").getter(getter(DescribeSnapshotScheduleResponse::recurrenceInHours))
.setter(setter(Builder::recurrenceInHours))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecurrenceInHours").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DescribeSnapshotScheduleResponse::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField TIMEZONE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Timezone").getter(getter(DescribeSnapshotScheduleResponse::timezone)).setter(setter(Builder::timezone))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Timezone").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(DescribeSnapshotScheduleResponse::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VOLUME_ARN_FIELD,
START_AT_FIELD, RECURRENCE_IN_HOURS_FIELD, DESCRIPTION_FIELD, TIMEZONE_FIELD, TAGS_FIELD));
private final String volumeARN;
private final Integer startAt;
private final Integer recurrenceInHours;
private final String description;
private final String timezone;
private final List tags;
private DescribeSnapshotScheduleResponse(BuilderImpl builder) {
super(builder);
this.volumeARN = builder.volumeARN;
this.startAt = builder.startAt;
this.recurrenceInHours = builder.recurrenceInHours;
this.description = builder.description;
this.timezone = builder.timezone;
this.tags = builder.tags;
}
/**
*
* The Amazon Resource Name (ARN) of the volume that was specified in the request.
*
*
* @return The Amazon Resource Name (ARN) of the volume that was specified in the request.
*/
public final String volumeARN() {
return volumeARN;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer startAt() {
return startAt;
}
/**
*
* The number of hours between snapshots.
*
*
* @return The number of hours between snapshots.
*/
public final Integer recurrenceInHours() {
return recurrenceInHours;
}
/**
*
* The snapshot description.
*
*
* @return The snapshot description.
*/
public final String description() {
return description;
}
/**
*
* A value that indicates the time zone of the gateway.
*
*
* @return A value that indicates the time zone of the gateway.
*/
public final String timezone() {
return timezone;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return 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.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(volumeARN());
hashCode = 31 * hashCode + Objects.hashCode(startAt());
hashCode = 31 * hashCode + Objects.hashCode(recurrenceInHours());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(timezone());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeSnapshotScheduleResponse)) {
return false;
}
DescribeSnapshotScheduleResponse other = (DescribeSnapshotScheduleResponse) obj;
return Objects.equals(volumeARN(), other.volumeARN()) && Objects.equals(startAt(), other.startAt())
&& Objects.equals(recurrenceInHours(), other.recurrenceInHours())
&& Objects.equals(description(), other.description()) && Objects.equals(timezone(), other.timezone())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeSnapshotScheduleResponse").add("VolumeARN", volumeARN()).add("StartAt", startAt())
.add("RecurrenceInHours", recurrenceInHours()).add("Description", description()).add("Timezone", timezone())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "VolumeARN":
return Optional.ofNullable(clazz.cast(volumeARN()));
case "StartAt":
return Optional.ofNullable(clazz.cast(startAt()));
case "RecurrenceInHours":
return Optional.ofNullable(clazz.cast(recurrenceInHours()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Timezone":
return Optional.ofNullable(clazz.cast(timezone()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeSnapshotScheduleResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends StorageGatewayResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the volume that was specified in the request.
*
*
* @param volumeARN
* The Amazon Resource Name (ARN) of the volume that was specified in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder volumeARN(String volumeARN);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startAt(Integer startAt);
/**
*
* The number of hours between snapshots.
*
*
* @param recurrenceInHours
* The number of hours between snapshots.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recurrenceInHours(Integer recurrenceInHours);
/**
*
* The snapshot description.
*
*
* @param description
* The snapshot description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* A value that indicates the time zone of the gateway.
*
*
* @param timezone
* A value that indicates the time zone of the gateway.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timezone(String timezone);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(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.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl extends StorageGatewayResponse.BuilderImpl implements Builder {
private String volumeARN;
private Integer startAt;
private Integer recurrenceInHours;
private String description;
private String timezone;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeSnapshotScheduleResponse model) {
super(model);
volumeARN(model.volumeARN);
startAt(model.startAt);
recurrenceInHours(model.recurrenceInHours);
description(model.description);
timezone(model.timezone);
tags(model.tags);
}
public final String getVolumeARN() {
return volumeARN;
}
public final void setVolumeARN(String volumeARN) {
this.volumeARN = volumeARN;
}
@Override
@Transient
public final Builder volumeARN(String volumeARN) {
this.volumeARN = volumeARN;
return this;
}
public final Integer getStartAt() {
return startAt;
}
public final void setStartAt(Integer startAt) {
this.startAt = startAt;
}
@Override
@Transient
public final Builder startAt(Integer startAt) {
this.startAt = startAt;
return this;
}
public final Integer getRecurrenceInHours() {
return recurrenceInHours;
}
public final void setRecurrenceInHours(Integer recurrenceInHours) {
this.recurrenceInHours = recurrenceInHours;
}
@Override
@Transient
public final Builder recurrenceInHours(Integer recurrenceInHours) {
this.recurrenceInHours = recurrenceInHours;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
@Transient
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getTimezone() {
return timezone;
}
public final void setTimezone(String timezone) {
this.timezone = timezone;
}
@Override
@Transient
public final Builder timezone(String timezone) {
this.timezone = timezone;
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
@Transient
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public DescribeSnapshotScheduleResponse build() {
return new DescribeSnapshotScheduleResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy