software.amazon.awssdk.services.backupgateway.model.Gateway Maven / Gradle / Ivy
Show all versions of backupgateway Show documentation
/*
* 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.backupgateway.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to
* backup storage in the Amazon Web Services Cloud.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Gateway implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField GATEWAY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayArn").getter(getter(Gateway::gatewayArn)).setter(setter(Builder::gatewayArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayArn").build()).build();
private static final SdkField GATEWAY_DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayDisplayName").getter(getter(Gateway::gatewayDisplayName))
.setter(setter(Builder::gatewayDisplayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayDisplayName").build())
.build();
private static final SdkField GATEWAY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GatewayType").getter(getter(Gateway::gatewayTypeAsString)).setter(setter(Builder::gatewayType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayType").build()).build();
private static final SdkField HYPERVISOR_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HypervisorId").getter(getter(Gateway::hypervisorId)).setter(setter(Builder::hypervisorId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HypervisorId").build()).build();
private static final SdkField LAST_SEEN_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastSeenTime").getter(getter(Gateway::lastSeenTime)).setter(setter(Builder::lastSeenTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastSeenTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GATEWAY_ARN_FIELD,
GATEWAY_DISPLAY_NAME_FIELD, GATEWAY_TYPE_FIELD, HYPERVISOR_ID_FIELD, LAST_SEEN_TIME_FIELD));
private static final long serialVersionUID = 1L;
private final String gatewayArn;
private final String gatewayDisplayName;
private final String gatewayType;
private final String hypervisorId;
private final Instant lastSeenTime;
private Gateway(BuilderImpl builder) {
this.gatewayArn = builder.gatewayArn;
this.gatewayDisplayName = builder.gatewayDisplayName;
this.gatewayType = builder.gatewayType;
this.hypervisorId = builder.hypervisorId;
this.lastSeenTime = builder.lastSeenTime;
}
/**
*
* The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of
* gateways for your account and Amazon Web Services Region.
*
*
* @return The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a
* list of gateways for your account and Amazon Web Services Region.
*/
public final String gatewayArn() {
return gatewayArn;
}
/**
*
* The display name of the gateway.
*
*
* @return The display name of the gateway.
*/
public final String gatewayDisplayName() {
return gatewayDisplayName;
}
/**
*
* The type of the gateway.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #gatewayType} will
* return {@link GatewayType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #gatewayTypeAsString}.
*
*
* @return The type of the gateway.
* @see GatewayType
*/
public final GatewayType gatewayType() {
return GatewayType.fromValue(gatewayType);
}
/**
*
* The type of the gateway.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #gatewayType} will
* return {@link GatewayType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #gatewayTypeAsString}.
*
*
* @return The type of the gateway.
* @see GatewayType
*/
public final String gatewayTypeAsString() {
return gatewayType;
}
/**
*
* The hypervisor ID of the gateway.
*
*
* @return The hypervisor ID of the gateway.
*/
public final String hypervisorId() {
return hypervisorId;
}
/**
*
* The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
*
*
* @return The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
*/
public final Instant lastSeenTime() {
return lastSeenTime;
}
@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 + Objects.hashCode(gatewayArn());
hashCode = 31 * hashCode + Objects.hashCode(gatewayDisplayName());
hashCode = 31 * hashCode + Objects.hashCode(gatewayTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hypervisorId());
hashCode = 31 * hashCode + Objects.hashCode(lastSeenTime());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Gateway)) {
return false;
}
Gateway other = (Gateway) obj;
return Objects.equals(gatewayArn(), other.gatewayArn())
&& Objects.equals(gatewayDisplayName(), other.gatewayDisplayName())
&& Objects.equals(gatewayTypeAsString(), other.gatewayTypeAsString())
&& Objects.equals(hypervisorId(), other.hypervisorId()) && Objects.equals(lastSeenTime(), other.lastSeenTime());
}
/**
* 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("Gateway").add("GatewayArn", gatewayArn()).add("GatewayDisplayName", gatewayDisplayName())
.add("GatewayType", gatewayTypeAsString()).add("HypervisorId", hypervisorId())
.add("LastSeenTime", lastSeenTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GatewayArn":
return Optional.ofNullable(clazz.cast(gatewayArn()));
case "GatewayDisplayName":
return Optional.ofNullable(clazz.cast(gatewayDisplayName()));
case "GatewayType":
return Optional.ofNullable(clazz.cast(gatewayTypeAsString()));
case "HypervisorId":
return Optional.ofNullable(clazz.cast(hypervisorId()));
case "LastSeenTime":
return Optional.ofNullable(clazz.cast(lastSeenTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function