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("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 Description

static interface DescribeGatewayInformationResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 Amazon Web Services 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)`
`String`	`gatewayARN()`	Returns the value of the GatewayARN property for this object.
`GatewayCapacity`	`gatewayCapacity()`	Specifies the size of the gateway's metadata cache.
`String`	`gatewayCapacityAsString()`	Specifies the size of the gateway's metadata cache.
`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)`
`boolean`	`hasGatewayNetworkInterfaces()`	For responses, this returns true if the service returned a value for the GatewayNetworkInterfaces property.
`int`	`hashCode()`
`boolean`	`hasSupportedGatewayCapacities()`	For responses, this returns true if the service returned a value for the SupportedGatewayCapacities property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`HostEnvironment`	`hostEnvironment()`	The type of hardware or software platform on which the gateway is running.
`String`	`hostEnvironmentAsString()`	The type of hardware or software platform on which the gateway is running.
`String`	`hostEnvironmentId()`	A unique identifier for the specific instance of the host platform running the gateway.
`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.
`String`	`softwareVersion()`	The version number of the software running on the gateway appliance.
`List<GatewayCapacity>`	`supportedGatewayCapacities()`	A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
`List<String>`	`supportedGatewayCapacitiesAsStrings()`	A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
`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 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()
```
    For responses, this returns true if the service returned a value for the GatewayNetworkInterfaces property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - 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.
    
    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 hasGatewayNetworkInterfaces() method.
    
    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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
    
    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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
  - 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 Amazon Web Services Region where the Amazon EC2 instance is located.
    
    Returns:
    
    The Amazon Web Services Region where the Amazon EC2 instance is located.
  - hasTags
```
public final boolean hasTags()
```
    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 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.
  - 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.
    
    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 hasTags() method.
    
    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. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
  - hostEnvironment
```
public final HostEnvironment hostEnvironment()
```
    The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    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 hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    See Also:
    
    HostEnvironment
  - hostEnvironmentAsString
```
public final String hostEnvironmentAsString()
```
    The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    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 hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    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.
  - gatewayCapacity
```
public final GatewayCapacity gatewayCapacity()
```
    Specifies the size of the gateway's metadata cache.
    
    If the service returns an enum value that is not available in the current SDK version, gatewayCapacity will return GatewayCapacity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gatewayCapacityAsString().
    
    Returns:
    
    Specifies the size of the gateway's metadata cache.
    
    See Also:
    
    GatewayCapacity
  - gatewayCapacityAsString
```
public final String gatewayCapacityAsString()
```
    Specifies the size of the gateway's metadata cache.
    
    If the service returns an enum value that is not available in the current SDK version, gatewayCapacity will return GatewayCapacity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gatewayCapacityAsString().
    
    Returns:
    
    Specifies the size of the gateway's metadata cache.
    
    See Also:
    
    GatewayCapacity
  - supportedGatewayCapacities
```
public final List<GatewayCapacity> supportedGatewayCapacities()
```
    A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
    
    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 hasSupportedGatewayCapacities() method.
    
    Returns:
    
    A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
  - hasSupportedGatewayCapacities
```
public final boolean hasSupportedGatewayCapacities()
```
    For responses, this returns true if the service returned a value for the SupportedGatewayCapacities property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - supportedGatewayCapacitiesAsStrings
```
public final List<String> supportedGatewayCapacitiesAsStrings()
```
    A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
    
    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 hasSupportedGatewayCapacities() method.
    
    Returns:
    
    A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
  - hostEnvironmentId
```
public final String hostEnvironmentId()
```
    A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
    
    Returns:
    
    A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
  - softwareVersion
```
public final String softwareVersion()
```
    The version number of the software running on the gateway appliance.
    
    Returns:
    
    The version number of the software running on the gateway appliance.
  - toBuilder
```
public DescribeGatewayInformationResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,DescribeGatewayInformationResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeGatewayInformationResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

gatewayARN

gatewayId

gatewayName

gatewayTimezone

gatewayState

hasGatewayNetworkInterfaces

gatewayNetworkInterfaces

gatewayType

nextUpdateAvailabilityDate

lastSoftwareUpdate

ec2InstanceId

ec2InstanceRegion

hasTags

tags

vpcEndpoint

cloudWatchLogGroupARN

hostEnvironment

hostEnvironmentAsString

endpointType

softwareUpdatesEndDate

deprecationDate

gatewayCapacity

gatewayCapacityAsString

supportedGatewayCapacities

hasSupportedGatewayCapacities

supportedGatewayCapacitiesAsStrings

hostEnvironmentId

softwareVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields