
software.amazon.awssdk.services.storagegateway.model.ActivateGatewayRequest 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.awscore.AwsRequestOverrideConfiguration;
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;
/**
*
* A JSON object containing one or more of the following fields:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ActivateGatewayRequest extends StorageGatewayRequest implements
ToCopyableBuilder {
private static final SdkField ACTIVATION_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ActivationKey").getter(getter(ActivateGatewayRequest::activationKey))
.setter(setter(Builder::activationKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ActivationKey").build()).build();
private static final SdkField GATEWAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayName").getter(getter(ActivateGatewayRequest::gatewayName)).setter(setter(Builder::gatewayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayName").build()).build();
private static final SdkField GATEWAY_TIMEZONE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayTimezone").getter(getter(ActivateGatewayRequest::gatewayTimezone))
.setter(setter(Builder::gatewayTimezone))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayTimezone").build()).build();
private static final SdkField GATEWAY_REGION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayRegion").getter(getter(ActivateGatewayRequest::gatewayRegion))
.setter(setter(Builder::gatewayRegion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayRegion").build()).build();
private static final SdkField GATEWAY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayType").getter(getter(ActivateGatewayRequest::gatewayType)).setter(setter(Builder::gatewayType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayType").build()).build();
private static final SdkField TAPE_DRIVE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TapeDriveType").getter(getter(ActivateGatewayRequest::tapeDriveType))
.setter(setter(Builder::tapeDriveType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TapeDriveType").build()).build();
private static final SdkField MEDIUM_CHANGER_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MediumChangerType").getter(getter(ActivateGatewayRequest::mediumChangerType))
.setter(setter(Builder::mediumChangerType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MediumChangerType").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(ActivateGatewayRequest::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(ACTIVATION_KEY_FIELD,
GATEWAY_NAME_FIELD, GATEWAY_TIMEZONE_FIELD, GATEWAY_REGION_FIELD, GATEWAY_TYPE_FIELD, TAPE_DRIVE_TYPE_FIELD,
MEDIUM_CHANGER_TYPE_FIELD, TAGS_FIELD));
private final String activationKey;
private final String gatewayName;
private final String gatewayTimezone;
private final String gatewayRegion;
private final String gatewayType;
private final String tapeDriveType;
private final String mediumChangerType;
private final List tags;
private ActivateGatewayRequest(BuilderImpl builder) {
super(builder);
this.activationKey = builder.activationKey;
this.gatewayName = builder.gatewayName;
this.gatewayTimezone = builder.gatewayTimezone;
this.gatewayRegion = builder.gatewayRegion;
this.gatewayType = builder.gatewayType;
this.tapeDriveType = builder.tapeDriveType;
this.mediumChangerType = builder.mediumChangerType;
this.tags = builder.tags;
}
/**
*
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects
* enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the
* activation key for your gateway in the query string parameter activationKey
. It may also include
* other activation-related parameters, however, these are merely defaults -- the arguments you pass to the
* ActivateGateway
API call determine the actual configuration of your gateway.
*
*
* For more information, see Getting activation
* key in the Storage Gateway User Guide.
*
*
* @return Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with
* redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides
* you the activation key for your gateway in the query string parameter activationKey
. It may
* also include other activation-related parameters, however, these are merely defaults -- the arguments you
* pass to the ActivateGateway
API call determine the actual configuration of your gateway.
*
* For more information, see Getting
* activation key in the Storage Gateway User Guide.
*/
public final String activationKey() {
return activationKey;
}
/**
*
* The name you configured for your gateway.
*
*
* @return The name you configured for your gateway.
*/
public final String gatewayName() {
return gatewayName;
}
/**
*
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm"
* or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2
* hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance
* schedule.
*
*
* @return A value that indicates the time zone you want to set for the gateway. The time zone is of the format
* "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00
* indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots
* and your gateway's maintenance schedule.
*/
public final String gatewayTimezone() {
return gatewayTimezone;
}
/**
*
* A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web
* Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your
* Host
header in the request. For more information about available Amazon Web Services Regions and
* endpoints for Storage Gateway, see Storage
* Gateway endpoints and quotas in the Amazon Web Services General Reference.
*
*
* Valid Values: See Storage Gateway endpoints and
* quotas in the Amazon Web Services General Reference.
*
*
* @return A value that indicates the Amazon Web Services Region where you want to store your data. The gateway
* Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web
* Services Region in your Host
header in the request. For more information about available
* Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in
* the Amazon Web Services General Reference.
*
* Valid Values: See Storage Gateway
* endpoints and quotas in the Amazon Web Services General Reference.
*/
public final String gatewayRegion() {
return gatewayRegion;
}
/**
*
* A value that defines the type of gateway to activate. The type specified is critical to all later functions of
* the gateway and cannot be changed after activation. The default value is CACHED
.
*
*
* Valid Values: STORED
| CACHED
| VTL
| FILE_S3
|
* FILE_FSX_SMB|
*
*
* @return A value that defines the type of gateway to activate. The type specified is critical to all later
* functions of the gateway and cannot be changed after activation. The default value is CACHED
* .
*
* Valid Values: STORED
| CACHED
| VTL
| FILE_S3
|
* FILE_FSX_SMB|
*/
public final String gatewayType() {
return gatewayType;
}
/**
*
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
*
* Valid Values: IBM-ULT3580-TD5
*
*
* @return The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
* Valid Values: IBM-ULT3580-TD5
*/
public final String tapeDriveType() {
return tapeDriveType;
}
/**
*
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
*
* Valid Values: STK-L700
| AWS-Gateway-VTL
| IBM-03584L32-0402
*
*
* @return The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
* Valid Values: STK-L700
| AWS-Gateway-VTL
| IBM-03584L32-0402
*/
public final String mediumChangerType() {
return mediumChangerType;
}
/**
* 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 that you can assign to the gateway. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers that can be represented 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 characters.
*
*
*
* 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 that you can assign to the gateway. Each tag is a key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers that can be represented 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 characters.
*
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(activationKey());
hashCode = 31 * hashCode + Objects.hashCode(gatewayName());
hashCode = 31 * hashCode + Objects.hashCode(gatewayTimezone());
hashCode = 31 * hashCode + Objects.hashCode(gatewayRegion());
hashCode = 31 * hashCode + Objects.hashCode(gatewayType());
hashCode = 31 * hashCode + Objects.hashCode(tapeDriveType());
hashCode = 31 * hashCode + Objects.hashCode(mediumChangerType());
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 ActivateGatewayRequest)) {
return false;
}
ActivateGatewayRequest other = (ActivateGatewayRequest) obj;
return Objects.equals(activationKey(), other.activationKey()) && Objects.equals(gatewayName(), other.gatewayName())
&& Objects.equals(gatewayTimezone(), other.gatewayTimezone())
&& Objects.equals(gatewayRegion(), other.gatewayRegion()) && Objects.equals(gatewayType(), other.gatewayType())
&& Objects.equals(tapeDriveType(), other.tapeDriveType())
&& Objects.equals(mediumChangerType(), other.mediumChangerType()) && 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("ActivateGatewayRequest").add("ActivationKey", activationKey()).add("GatewayName", gatewayName())
.add("GatewayTimezone", gatewayTimezone()).add("GatewayRegion", gatewayRegion())
.add("GatewayType", gatewayType()).add("TapeDriveType", tapeDriveType())
.add("MediumChangerType", mediumChangerType()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ActivationKey":
return Optional.ofNullable(clazz.cast(activationKey()));
case "GatewayName":
return Optional.ofNullable(clazz.cast(gatewayName()));
case "GatewayTimezone":
return Optional.ofNullable(clazz.cast(gatewayTimezone()));
case "GatewayRegion":
return Optional.ofNullable(clazz.cast(gatewayRegion()));
case "GatewayType":
return Optional.ofNullable(clazz.cast(gatewayType()));
case "TapeDriveType":
return Optional.ofNullable(clazz.cast(tapeDriveType()));
case "MediumChangerType":
return Optional.ofNullable(clazz.cast(mediumChangerType()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function