software.amazon.awssdk.services.storagegateway.model

Class DescribeGatewayInformationResponse

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.DescribeGatewayInformationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeGatewayInformationResponse
extends StorageGatewayResponse
implements ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>

A JSON object containing the following fields:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeGatewayInformationResponse.Builder

Method Summary

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.

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

gatewayARN

public final String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

gatewayId

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.

Returns:

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.

gatewayName

public final String gatewayName()

The name you configured for your gateway.

Returns:

The name you configured for your gateway.

gatewayTimezone

public final String gatewayTimezone()

A value that indicates the time zone configured for the gateway.

Returns:

A value that indicates the time zone configured for the gateway.

gatewayState

public final String gatewayState()

A value that indicates the operating state of the gateway.

Returns:

A value that indicates the operating state of the gateway.

hasGatewayNetworkInterfaces

public final 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). For responses returned by the SDK, the sender is the AWS service.

gatewayNetworkInterfaces

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.

Returns:

A NetworkInterface array that contains descriptions of the gateway network interfaces.

gatewayType

public final String gatewayType()

The type of the gateway.

Returns:

The type of the gateway.

nextUpdateAvailabilityDate

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.

Returns:

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.

lastSoftwareUpdate

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.

Returns:

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.

ec2InstanceId

public final String ec2InstanceId()

The ID of the Amazon EC2 instance that was used to launch the gateway.

Returns:

The ID of the Amazon EC2 instance that was used to launch the gateway.

ec2InstanceRegion

public final String ec2InstanceRegion()

The AWS Region where the Amazon EC2 instance is located.

Returns:

The AWS Region where the Amazon EC2 instance is located.

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 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.

Returns:

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.

vpcEndpoint

public final String vpcEndpoint()

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

Returns:

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

cloudWatchLogGroupARN

public final String cloudWatchLogGroupARN()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.

Returns:

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.

hostEnvironment

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

Returns:

The type of hypervisor environment used by the host.

See Also:

HostEnvironment

hostEnvironmentAsString

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

Returns:

The type of hypervisor environment used by the host.

See Also:

HostEnvironment

endpointType

public final String endpointType()

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

Returns:

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

softwareUpdatesEndDate

public final String softwareUpdatesEndDate()

Date after which this gateway will not receive software updates for new features.

Returns:

Date after which this gateway will not receive software updates for new features.

deprecationDate

public final String deprecationDate()

Date after which this gateway will not receive software updates for new features and bug fixes.

Returns:

Date after which this gateway will not receive software updates for new features and bug fixes.

toBuilder

public DescribeGatewayInformationResponse.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<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeGatewayInformationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeGatewayInformationResponse.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.