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	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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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)
int	hashCode()
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()
List<Tag>	tags() A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.
DescribeGatewayInformationResponse.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

gatewayARN

public String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

gatewayId

public 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 String gatewayName()

The name you configured for your gateway.

Returns:

The name you configured for your gateway.

gatewayTimezone

public 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 String gatewayState()

A value that indicates the operating state of the gateway.

Returns:

A value that indicates the operating state of the gateway.

gatewayNetworkInterfaces

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

Returns:

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

gatewayType

public String gatewayType()

The type of the gateway.

Returns:

The type of the gateway.

nextUpdateAvailabilityDate

public 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 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 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 String ec2InstanceRegion()

The AWS Region where the Amazon EC2 instance is located.

Returns:

The AWS Region where the Amazon EC2 instance is located.

tags

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

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

toBuilder

public DescribeGatewayInformationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeGatewayInformationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeGatewayInformationResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo