Class DescribeGatewayInformationResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeGatewayInformationResponse.Builder,
DescribeGatewayInformationResponse>
A JSON object containing the following fields:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.final String
Date after which this gateway will not receive software updates for new features and bug fixes.final String
The ID of the Amazon EC2 instance that was used to launch the gateway.final String
The Amazon Web Services Region where the Amazon EC2 instance is located.final String
The type of endpoint for your gateway.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Returns the value of the GatewayARN property for this object.final GatewayCapacity
Specifies the size of the gateway's metadata cache.final String
Specifies the size of the gateway's metadata cache.final String
The unique identifier assigned to your gateway during activation.final String
The name you configured for your gateway.final List
<NetworkInterface> A NetworkInterface array that contains descriptions of the gateway network interfaces.final String
A value that indicates the operating state of the gateway.final String
A value that indicates the time zone configured for the gateway.final String
The type of the gateway.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the GatewayNetworkInterfaces property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedGatewayCapacities property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final HostEnvironment
The type of hardware or software platform on which the gateway is running.final String
The type of hardware or software platform on which the gateway is running.final String
A unique identifier for the specific instance of the host platform running the gateway.final String
The date on which the last software update was applied to the gateway.final String
The date on which an update to the gateway is available.static Class
<? extends DescribeGatewayInformationResponse.Builder> final String
Date after which this gateway will not receive software updates for new features.final String
The version number of the software running on the gateway appliance.final List
<GatewayCapacity> A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.tags()
A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
gatewayARN
Returns the value of the GatewayARN property for this object.- Returns:
- The value of the GatewayARN property for this object.
-
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
The name you configured for your gateway.
- Returns:
- The name you configured for your gateway.
-
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
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 theisEmpty()
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
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
The type of the gateway.
- Returns:
- The type of the gateway.
-
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
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
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
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 theisEmpty()
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
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
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
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
The type of hardware or software platform on which the gateway is running.
If the service returns an enum value that is not available in the current SDK version,
hostEnvironment
will returnHostEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostEnvironmentAsString()
.- Returns:
- The type of hardware or software platform on which the gateway is running.
- See Also:
-
hostEnvironmentAsString
The type of hardware or software platform on which the gateway is running.
If the service returns an enum value that is not available in the current SDK version,
hostEnvironment
will returnHostEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostEnvironmentAsString()
.- Returns:
- The type of hardware or software platform on which the gateway is running.
- See Also:
-
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
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
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
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 returnGatewayCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgatewayCapacityAsString()
.- Returns:
- Specifies the size of the gateway's metadata cache.
- See Also:
-
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 returnGatewayCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgatewayCapacityAsString()
.- Returns:
- Specifies the size of the gateway's metadata cache.
- See Also:
-
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 theisEmpty()
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
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
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
The version number of the software running on the gateway appliance.
- Returns:
- The version number of the software running on the gateway appliance.
-
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 interfaceToCopyableBuilder<DescribeGatewayInformationResponse.Builder,
DescribeGatewayInformationResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeGatewayInformationResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-