GatewayInfo (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.storagegateway.model.GatewayInfo

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GatewayInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a gateway object.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GatewayInfo()

Constructors
Constructor and Description
`GatewayInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GatewayInfo`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeprecationDate()` Date after which this gateway will not receive software updates for new features and bug fixes.
`String`	`getEc2InstanceId()` The ID of the Amazon EC2 instance that was used to launch the gateway.
`String`	`getEc2InstanceRegion()` The Amazon Web Services Region where the Amazon EC2 instance is located.
`String`	`getGatewayARN()` The Amazon Resource Name (ARN) of the gateway.
`String`	`getGatewayId()` The unique identifier assigned to your gateway during activation.
`String`	`getGatewayName()` The name of the gateway.
`String`	`getGatewayOperationalState()` The state of the gateway.
`String`	`getGatewayType()` The type of the gateway.
`String`	`getHostEnvironment()` The type of hardware or software platform on which the gateway is running.
`String`	`getHostEnvironmentId()` A unique identifier for the specific instance of the host platform running the gateway.
`String`	`getSoftwareVersion()` The version number of the software running on the gateway appliance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDeprecationDate(String deprecationDate)` Date after which this gateway will not receive software updates for new features and bug fixes.
`void`	`setEc2InstanceId(String ec2InstanceId)` The ID of the Amazon EC2 instance that was used to launch the gateway.
`void`	`setEc2InstanceRegion(String ec2InstanceRegion)` The Amazon Web Services Region where the Amazon EC2 instance is located.
`void`	`setGatewayARN(String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
`void`	`setGatewayId(String gatewayId)` The unique identifier assigned to your gateway during activation.
`void`	`setGatewayName(String gatewayName)` The name of the gateway.
`void`	`setGatewayOperationalState(String gatewayOperationalState)` The state of the gateway.
`void`	`setGatewayType(String gatewayType)` The type of the gateway.
`void`	`setHostEnvironment(String hostEnvironment)` The type of hardware or software platform on which the gateway is running.
`void`	`setHostEnvironmentId(String hostEnvironmentId)` A unique identifier for the specific instance of the host platform running the gateway.
`void`	`setSoftwareVersion(String softwareVersion)` The version number of the software running on the gateway appliance.
`String`	`toString()` Returns a string representation of this object.
`GatewayInfo`	`withDeprecationDate(String deprecationDate)` Date after which this gateway will not receive software updates for new features and bug fixes.
`GatewayInfo`	`withEc2InstanceId(String ec2InstanceId)` The ID of the Amazon EC2 instance that was used to launch the gateway.
`GatewayInfo`	`withEc2InstanceRegion(String ec2InstanceRegion)` The Amazon Web Services Region where the Amazon EC2 instance is located.
`GatewayInfo`	`withGatewayARN(String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
`GatewayInfo`	`withGatewayId(String gatewayId)` The unique identifier assigned to your gateway during activation.
`GatewayInfo`	`withGatewayName(String gatewayName)` The name of the gateway.
`GatewayInfo`	`withGatewayOperationalState(String gatewayOperationalState)` The state of the gateway.
`GatewayInfo`	`withGatewayType(String gatewayType)` The type of the gateway.
`GatewayInfo`	`withHostEnvironment(HostEnvironment hostEnvironment)` The type of hardware or software platform on which the gateway is running.
`GatewayInfo`	`withHostEnvironment(String hostEnvironment)` The type of hardware or software platform on which the gateway is running.
`GatewayInfo`	`withHostEnvironmentId(String hostEnvironmentId)` A unique identifier for the specific instance of the host platform running the gateway.
`GatewayInfo`	`withSoftwareVersion(String softwareVersion)` The version number of the software running on the gateway appliance.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GatewayInfo
```
public GatewayInfo()
```
- Method Detail
  - setGatewayId
```
public void setGatewayId(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.
    
    Parameters:
    
    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.
  - getGatewayId
```
public String getGatewayId()
```
    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.
  - withGatewayId
```
public GatewayInfo withGatewayId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGatewayARN
```
public void setGatewayARN(String gatewayARN)
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
    
    Parameters:
    
    gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
  - getGatewayARN
```
public String getGatewayARN()
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
  - withGatewayARN
```
public GatewayInfo withGatewayARN(String gatewayARN)
```
    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
    
    Parameters:
    
    gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGatewayType
```
public void setGatewayType(String gatewayType)
```
    The type of the gateway.
    
    Parameters:
    
    gatewayType - The type of the gateway.
  - getGatewayType
```
public String getGatewayType()
```
    The type of the gateway.
    
    Returns:
    
    The type of the gateway.
  - withGatewayType
```
public GatewayInfo withGatewayType(String gatewayType)
```
    The type of the gateway.
    
    Parameters:
    
    gatewayType - The type of the gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGatewayOperationalState
```
public void setGatewayOperationalState(String gatewayOperationalState)
```
    The state of the gateway.
    
    Valid Values: DISABLED | ACTIVE
    
    Parameters:
    
    gatewayOperationalState - The state of the gateway.
    
    Valid Values: DISABLED | ACTIVE
  - getGatewayOperationalState
```
public String getGatewayOperationalState()
```
    The state of the gateway.
    
    Valid Values: DISABLED | ACTIVE
    
    Returns:
    
    The state of the gateway.
    
    Valid Values: DISABLED | ACTIVE
  - withGatewayOperationalState
```
public GatewayInfo withGatewayOperationalState(String gatewayOperationalState)
```
    The state of the gateway.
    
    Valid Values: DISABLED | ACTIVE
    
    Parameters:
    
    gatewayOperationalState - The state of the gateway.
    
    Valid Values: DISABLED | ACTIVE
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGatewayName
```
public void setGatewayName(String gatewayName)
```
    The name of the gateway.
    
    Parameters:
    
    gatewayName - The name of the gateway.
  - getGatewayName
```
public String getGatewayName()
```
    The name of the gateway.
    
    Returns:
    
    The name of the gateway.
  - withGatewayName
```
public GatewayInfo withGatewayName(String gatewayName)
```
    The name of the gateway.
    
    Parameters:
    
    gatewayName - The name of the gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2InstanceId
```
public void setEc2InstanceId(String ec2InstanceId)
```
    The ID of the Amazon EC2 instance that was used to launch the gateway.
    
    Parameters:
    
    ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.
  - getEc2InstanceId
```
public String getEc2InstanceId()
```
    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.
  - withEc2InstanceId
```
public GatewayInfo withEc2InstanceId(String ec2InstanceId)
```
    The ID of the Amazon EC2 instance that was used to launch the gateway.
    
    Parameters:
    
    ec2InstanceId - The ID of the Amazon EC2 instance that was used to launch the gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2InstanceRegion
```
public void setEc2InstanceRegion(String ec2InstanceRegion)
```
    The Amazon Web Services Region where the Amazon EC2 instance is located.
    
    Parameters:
    
    ec2InstanceRegion - The Amazon Web Services Region where the Amazon EC2 instance is located.
  - getEc2InstanceRegion
```
public String getEc2InstanceRegion()
```
    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.
  - withEc2InstanceRegion
```
public GatewayInfo withEc2InstanceRegion(String ec2InstanceRegion)
```
    The Amazon Web Services Region where the Amazon EC2 instance is located.
    
    Parameters:
    
    ec2InstanceRegion - The Amazon Web Services Region where the Amazon EC2 instance is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostEnvironment
```
public void setHostEnvironment(String hostEnvironment)
```
    The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    Parameters:
    
    hostEnvironment - 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
  - getHostEnvironment
```
public String getHostEnvironment()
```
    The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    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
  - withHostEnvironment
```
public GatewayInfo withHostEnvironment(String hostEnvironment)
```
    The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    Parameters:
    
    hostEnvironment - The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HostEnvironment
  - withHostEnvironment
```
public GatewayInfo withHostEnvironment(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.
    
    Parameters:
    
    hostEnvironment - The type of hardware or software platform on which the gateway is running.
    
    Tape Gateway is no longer available on Snow Family devices.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HostEnvironment
  - setHostEnvironmentId
```
public void setHostEnvironmentId(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.
    
    Parameters:
    
    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.
  - getHostEnvironmentId
```
public String getHostEnvironmentId()
```
    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.
  - withHostEnvironmentId
```
public GatewayInfo withHostEnvironmentId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeprecationDate
```
public void setDeprecationDate(String deprecationDate)
```
    Date after which this gateway will not receive software updates for new features and bug fixes.
    
    Parameters:
    
    deprecationDate - Date after which this gateway will not receive software updates for new features and bug fixes.
  - getDeprecationDate
```
public String getDeprecationDate()
```
    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.
  - withDeprecationDate
```
public GatewayInfo withDeprecationDate(String deprecationDate)
```
    Date after which this gateway will not receive software updates for new features and bug fixes.
    
    Parameters:
    
    deprecationDate - Date after which this gateway will not receive software updates for new features and bug fixes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSoftwareVersion
```
public void setSoftwareVersion(String softwareVersion)
```
    The version number of the software running on the gateway appliance.
    
    Parameters:
    
    softwareVersion - The version number of the software running on the gateway appliance.
  - getSoftwareVersion
```
public String getSoftwareVersion()
```
    The version number of the software running on the gateway appliance.
    
    Returns:
    
    The version number of the software running on the gateway appliance.
  - withSoftwareVersion
```
public GatewayInfo withSoftwareVersion(String softwareVersion)
```
    The version number of the software running on the gateway appliance.
    
    Parameters:
    
    softwareVersion - The version number of the software running on the gateway appliance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GatewayInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class GatewayInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatewayInfo

Method Detail

setGatewayId

getGatewayId

withGatewayId

setGatewayARN

getGatewayARN

withGatewayARN

setGatewayType

getGatewayType

withGatewayType

setGatewayOperationalState

getGatewayOperationalState

withGatewayOperationalState

setGatewayName

getGatewayName

withGatewayName

setEc2InstanceId

getEc2InstanceId

withEc2InstanceId

setEc2InstanceRegion

getEc2InstanceRegion

withEc2InstanceRegion

setHostEnvironment

getHostEnvironment

withHostEnvironment

withHostEnvironment

setHostEnvironmentId

getHostEnvironmentId

withHostEnvironmentId

setDeprecationDate

getDeprecationDate

withDeprecationDate

setSoftwareVersion

getSoftwareVersion

withSoftwareVersion

toString

equals

hashCode

clone

marshall