@Generated(value="software.amazon.awssdk:codegen") public final class DescribeGatewayInformationResponse extends StorageGatewayResponse implements ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>
A JSON object containing the following fields:
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeGatewayInformationResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeGatewayInformationResponse.Builder |
builder() |
String |
cloudWatchLogGroupARN()
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.
|
String |
deprecationDate()
Date after which this gateway will not receive software updates for new features and bug fixes.
|
String |
ec2InstanceId()
The ID of the Amazon EC2 instance that was used to launch the gateway.
|
String |
ec2InstanceRegion()
The AWS Region where the Amazon EC2 instance is located.
|
String |
endpointType()
The type of endpoint for your gateway.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
gatewayARN()
Returns the value of the GatewayARN property for this object.
|
String |
gatewayId()
The unique identifier assigned to your gateway during activation.
|
String |
gatewayName()
The name you configured for your gateway.
|
List<NetworkInterface> |
gatewayNetworkInterfaces()
A NetworkInterface array that contains descriptions of the gateway network interfaces.
|
String |
gatewayState()
A value that indicates the operating state of the gateway.
|
String |
gatewayTimezone()
A value that indicates the time zone configured for the gateway.
|
String |
gatewayType()
The type of the gateway.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
boolean |
hasGatewayNetworkInterfaces()
Returns true if the GatewayNetworkInterfaces property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
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).
|
HostEnvironment |
hostEnvironment()
The type of hypervisor environment used by the host.
|
String |
hostEnvironmentAsString()
The type of hypervisor environment used by the host.
|
String |
lastSoftwareUpdate()
The date on which the last software update was applied to the gateway.
|
String |
nextUpdateAvailabilityDate()
The date on which an update to the gateway is available.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeGatewayInformationResponse.Builder> |
serializableBuilderClass() |
String |
softwareUpdatesEndDate()
Date after which this gateway will not receive software updates for new features.
|
List<Tag> |
tags()
A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.
|
DescribeGatewayInformationResponse.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 |
vpcEndpoint()
The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
|
responseMetadata
sdkHttpResponse
copy
public final String gatewayARN()
public final String gatewayId()
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
public final String gatewayName()
The name you configured for your gateway.
public final String gatewayTimezone()
A value that indicates the time zone configured for the gateway.
public final String gatewayState()
A value that indicates the operating state of the gateway.
public final boolean hasGatewayNetworkInterfaces()
public final List<NetworkInterface> gatewayNetworkInterfaces()
A NetworkInterface array that contains descriptions of the gateway network interfaces.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasGatewayNetworkInterfaces()
to see if a value was sent in this field.
public final String gatewayType()
The type of the gateway.
public final String nextUpdateAvailabilityDate()
The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
public final String lastSoftwareUpdate()
The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
public final String ec2InstanceId()
The ID of the Amazon EC2 instance that was used to launch the gateway.
public final String ec2InstanceRegion()
The AWS Region where the Amazon EC2 instance is located.
public final boolean hasTags()
public final List<Tag> tags()
A list of up to 50 tags assigned to the gateway, 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.
ListTagsForResource
API operation.public final String vpcEndpoint()
The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
public final String cloudWatchLogGroupARN()
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.
public final HostEnvironment hostEnvironment()
The type of hypervisor environment used by the host.
If the service returns an enum value that is not available in the current SDK version, hostEnvironment
will return HostEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from hostEnvironmentAsString()
.
HostEnvironment
public final String hostEnvironmentAsString()
The type of hypervisor environment used by the host.
If the service returns an enum value that is not available in the current SDK version, hostEnvironment
will return HostEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from hostEnvironmentAsString()
.
HostEnvironment
public final String endpointType()
The type of endpoint for your gateway.
Valid Values: STANDARD
| FIPS
Valid Values: STANDARD
| FIPS
public final String softwareUpdatesEndDate()
Date after which this gateway will not receive software updates for new features.
public final String deprecationDate()
Date after which this gateway will not receive software updates for new features and bug fixes.
public DescribeGatewayInformationResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>
toBuilder
in class AwsResponse
public static DescribeGatewayInformationResponse.Builder builder()
public static Class<? extends DescribeGatewayInformationResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.