java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.network.Gateway

```
@ApiType("SoftLayer_Network_Gateway")
public class Gateway
extends Entity
```
A network gateway is a set of members which have a configurable set of VLANs trunked through them. This is helpful for creating proxies. Each network gateway can have a configurable set of hardware and VLANs within the same pod routed to it. Gateways can be bypassed or unbypassed either as a whole or for specific VLANs. They are also provided gateway VLANs for management that are never bypassed. Members cannot be simply removed once attached to a gateway, they must be reclaimed.

See Also:

SoftLayer_Network_Gateway

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Gateway.Mask`
`static interface`	`Gateway.Service`	A network gateway is a set of members which have a configurable set of VLANs trunked through them.
`static interface`	`Gateway.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`	The account for this gateway.
`protected Long`	`accountId`	The internal identifier of the account assigned to this gateway.
`protected boolean`	`accountIdSpecified`
`protected Long`	`groupNumber`	The VRRP group number for this gateway.
`protected boolean`	`groupNumberSpecified`
`protected Long`	`id`	A gateway's internal identifier.
`protected boolean`	`idSpecified`
`protected Long`	`insideVlanCount`	A count of all VLANs trunked to this gateway.
`protected List<Vlan>`	`insideVlans`	All VLANs trunked to this gateway.
`protected Long`	`memberCount`	A count of the members for this gateway.
`protected List<Member>`	`members`	The members for this gateway.
`protected String`	`name`	A gateway's name.
`protected boolean`	`nameSpecified`
`protected Firewall`	`networkFirewall`	The firewall associated with this gateway, if any.
`protected Boolean`	`networkFirewallFlag`	Whether or not there is a firewall associated with this gateway.
`protected String`	`networkSpace`	A gateway's network space.
`protected boolean`	`networkSpaceSpecified`
`protected IpAddress`	`privateIpAddress`	The private gateway IP address.
`protected Long`	`privateIpAddressId`	The internal identifier of the private IP address for this gateway.
`protected boolean`	`privateIpAddressIdSpecified`
`protected Vlan`	`privateVlan`	The private VLAN for accessing this gateway.
`protected Long`	`privateVlanId`	The internal identifier of the private VLAN for this gateway.
`protected boolean`	`privateVlanIdSpecified`
`protected IpAddress`	`publicIpAddress`	The public gateway IP address.
`protected Long`	`publicIpAddressId`	The internal identifier of the public IP address for this gateway.
`protected boolean`	`publicIpAddressIdSpecified`
`protected IpAddress`	`publicIpv6Address`	The public gateway IPv6 address.
`protected Long`	`publicIpv6AddressId`	The internal identifier of the public IPv6 address for this gateway.
`protected boolean`	`publicIpv6AddressIdSpecified`
`protected Vlan`	`publicVlan`	The public VLAN for accessing this gateway.
`protected Long`	`publicVlanId`	The internal identifier of the public VLAN for this gateway.
`protected boolean`	`publicVlanIdSpecified`
`protected Status`	`status`	The current status of the gateway.
`protected Long`	`statusId`	The current status of this gateway.
`protected boolean`	`statusIdSpecified`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Gateway()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Gateway.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountId()`
`Long`	`getGroupNumber()`
`Long`	`getId()`
`Long`	`getInsideVlanCount()`
`List<Vlan>`	`getInsideVlans()`
`Long`	`getMemberCount()`
`List<Member>`	`getMembers()`
`String`	`getName()`
`Firewall`	`getNetworkFirewall()`
`Boolean`	`getNetworkFirewallFlag()`
`String`	`getNetworkSpace()`
`IpAddress`	`getPrivateIpAddress()`
`Long`	`getPrivateIpAddressId()`
`Vlan`	`getPrivateVlan()`
`Long`	`getPrivateVlanId()`
`IpAddress`	`getPublicIpAddress()`
`Long`	`getPublicIpAddressId()`
`IpAddress`	`getPublicIpv6Address()`
`Long`	`getPublicIpv6AddressId()`
`Vlan`	`getPublicVlan()`
`Long`	`getPublicVlanId()`
`Status`	`getStatus()`
`Long`	`getStatusId()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isGroupNumberSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isNetworkSpaceSpecified()`
`boolean`	`isPrivateIpAddressIdSpecified()`
`boolean`	`isPrivateVlanIdSpecified()`
`boolean`	`isPublicIpAddressIdSpecified()`
`boolean`	`isPublicIpv6AddressIdSpecified()`
`boolean`	`isPublicVlanIdSpecified()`
`boolean`	`isStatusIdSpecified()`
`static Gateway.Service`	`service(ApiClient client)`
`static Gateway.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Long accountId)`
`void`	`setGroupNumber(Long groupNumber)`
`void`	`setId(Long id)`
`void`	`setInsideVlanCount(Long insideVlanCount)`
`void`	`setMemberCount(Long memberCount)`
`void`	`setName(String name)`
`void`	`setNetworkFirewall(Firewall networkFirewall)`
`void`	`setNetworkFirewallFlag(Boolean networkFirewallFlag)`
`void`	`setNetworkSpace(String networkSpace)`
`void`	`setPrivateIpAddress(IpAddress privateIpAddress)`
`void`	`setPrivateIpAddressId(Long privateIpAddressId)`
`void`	`setPrivateVlan(Vlan privateVlan)`
`void`	`setPrivateVlanId(Long privateVlanId)`
`void`	`setPublicIpAddress(IpAddress publicIpAddress)`
`void`	`setPublicIpAddressId(Long publicIpAddressId)`
`void`	`setPublicIpv6Address(IpAddress publicIpv6Address)`
`void`	`setPublicIpv6AddressId(Long publicIpv6AddressId)`
`void`	`setPublicVlan(Vlan publicVlan)`
`void`	`setPublicVlanId(Long publicVlanId)`
`void`	`setStatus(Status status)`
`void`	`setStatusId(Long statusId)`
`void`	`unsetAccountId()`
`void`	`unsetGroupNumber()`
`void`	`unsetId()`
`void`	`unsetName()`
`void`	`unsetNetworkSpace()`
`void`	`unsetPrivateIpAddressId()`
`void`	`unsetPrivateVlanId()`
`void`	`unsetPublicIpAddressId()`
`void`	`unsetPublicIpv6AddressId()`
`void`	`unsetPublicVlanId()`
`void`	`unsetStatusId()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- account
```
@ApiProperty
protected Account account
```
  The account for this gateway.
- insideVlans
```
@ApiProperty
protected List<Vlan> insideVlans
```
  All VLANs trunked to this gateway.
- members
```
@ApiProperty
protected List<Member> members
```
  The members for this gateway.
- networkFirewall
```
@ApiProperty
protected Firewall networkFirewall
```
  The firewall associated with this gateway, if any.
- networkFirewallFlag
```
@ApiProperty
protected Boolean networkFirewallFlag
```
  Whether or not there is a firewall associated with this gateway.
- privateIpAddress
```
@ApiProperty
protected IpAddress privateIpAddress
```
  The private gateway IP address.
- privateVlan
```
@ApiProperty
protected Vlan privateVlan
```
  The private VLAN for accessing this gateway.
- publicIpAddress
```
@ApiProperty
protected IpAddress publicIpAddress
```
  The public gateway IP address.
- publicIpv6Address
```
@ApiProperty
protected IpAddress publicIpv6Address
```
  The public gateway IPv6 address.
- publicVlan
```
@ApiProperty
protected Vlan publicVlan
```
  The public VLAN for accessing this gateway.
- status
```
@ApiProperty
protected Status status
```
  The current status of the gateway.
- accountId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long accountId
```
  The internal identifier of the account assigned to this gateway.
- accountIdSpecified
```
protected boolean accountIdSpecified
```
- groupNumber
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long groupNumber
```
  The VRRP group number for this gateway. This is set internally and cannot be provided on create.
- groupNumberSpecified
```
protected boolean groupNumberSpecified
```
- id
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long id
```
  A gateway's internal identifier.
- idSpecified
```
protected boolean idSpecified
```
- name
```
@ApiProperty(canBeNullOrNotSet=true)
protected String name
```
  A gateway's name. This is required on create and can be no more than 255 characters.
- nameSpecified
```
protected boolean nameSpecified
```
- networkSpace
```
@ApiProperty(canBeNullOrNotSet=true)
protected String networkSpace
```
  A gateway's network space. Currently, only 'private' or 'both' is allowed. When this value is 'private', it is a backend gateway only. Otherwise, it is a gateway for both frontend and backend traffic.
- networkSpaceSpecified
```
protected boolean networkSpaceSpecified
```
- privateIpAddressId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long privateIpAddressId
```
  The internal identifier of the private IP address for this gateway.
- privateIpAddressIdSpecified
```
protected boolean privateIpAddressIdSpecified
```
- privateVlanId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long privateVlanId
```
  The internal identifier of the private VLAN for this gateway.
- privateVlanIdSpecified
```
protected boolean privateVlanIdSpecified
```
- publicIpAddressId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long publicIpAddressId
```
  The internal identifier of the public IP address for this gateway.
- publicIpAddressIdSpecified
```
protected boolean publicIpAddressIdSpecified
```
- publicIpv6AddressId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long publicIpv6AddressId
```
  The internal identifier of the public IPv6 address for this gateway.
- publicIpv6AddressIdSpecified
```
protected boolean publicIpv6AddressIdSpecified
```
- publicVlanId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long publicVlanId
```
  The internal identifier of the public VLAN for this gateway. This is set internally and cannot be provided on create.
- publicVlanIdSpecified
```
protected boolean publicVlanIdSpecified
```
- statusId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long statusId
```
  The current status of this gateway. This is always active unless there is a process running to change the gateway. This can not be set on creation.
- statusIdSpecified
```
protected boolean statusIdSpecified
```
- insideVlanCount
```
@ApiProperty
protected Long insideVlanCount
```
  A count of all VLANs trunked to this gateway.
- memberCount
```
@ApiProperty
protected Long memberCount
```
  A count of the members for this gateway.

Constructor Detail
- Gateway
```
public Gateway()
```

Method Detail

getAccount
```
public Account getAccount()
```

setAccount

public void setAccount(Account account)

getInsideVlans
```
public List<Vlan> getInsideVlans()
```

getMembers
```
public List<Member> getMembers()
```

getNetworkFirewall
```
public Firewall getNetworkFirewall()
```

setNetworkFirewall

public void setNetworkFirewall(Firewall networkFirewall)

getNetworkFirewallFlag

public Boolean getNetworkFirewallFlag()

setNetworkFirewallFlag

public void setNetworkFirewallFlag(Boolean networkFirewallFlag)

getPrivateIpAddress

public IpAddress getPrivateIpAddress()

setPrivateIpAddress

public void setPrivateIpAddress(IpAddress privateIpAddress)

getPrivateVlan
```
public Vlan getPrivateVlan()
```

setPrivateVlan

public void setPrivateVlan(Vlan privateVlan)

getPublicIpAddress
```
public IpAddress getPublicIpAddress()
```

setPublicIpAddress

public void setPublicIpAddress(IpAddress publicIpAddress)

getPublicIpv6Address

public IpAddress getPublicIpv6Address()

setPublicIpv6Address

public void setPublicIpv6Address(IpAddress publicIpv6Address)

getPublicVlan
```
public Vlan getPublicVlan()
```

setPublicVlan

public void setPublicVlan(Vlan publicVlan)

getStatus
```
public Status getStatus()
```

setStatus

public void setStatus(Status status)

getAccountId
```
public Long getAccountId()
```

setAccountId

public void setAccountId(Long accountId)

isAccountIdSpecified
```
public boolean isAccountIdSpecified()
```

unsetAccountId
```
public void unsetAccountId()
```

getGroupNumber
```
public Long getGroupNumber()
```

setGroupNumber

public void setGroupNumber(Long groupNumber)

isGroupNumberSpecified

public boolean isGroupNumberSpecified()

unsetGroupNumber
```
public void unsetGroupNumber()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isNameSpecified
```
public boolean isNameSpecified()
```

unsetName
```
public void unsetName()
```

getNetworkSpace
```
public String getNetworkSpace()
```

setNetworkSpace

public void setNetworkSpace(String networkSpace)

isNetworkSpaceSpecified

public boolean isNetworkSpaceSpecified()

unsetNetworkSpace
```
public void unsetNetworkSpace()
```

getPrivateIpAddressId
```
public Long getPrivateIpAddressId()
```

setPrivateIpAddressId

public void setPrivateIpAddressId(Long privateIpAddressId)

isPrivateIpAddressIdSpecified

public boolean isPrivateIpAddressIdSpecified()

unsetPrivateIpAddressId
```
public void unsetPrivateIpAddressId()
```

getPrivateVlanId
```
public Long getPrivateVlanId()
```

setPrivateVlanId

public void setPrivateVlanId(Long privateVlanId)

isPrivateVlanIdSpecified

public boolean isPrivateVlanIdSpecified()

unsetPrivateVlanId
```
public void unsetPrivateVlanId()
```

getPublicIpAddressId
```
public Long getPublicIpAddressId()
```

setPublicIpAddressId

public void setPublicIpAddressId(Long publicIpAddressId)

isPublicIpAddressIdSpecified

public boolean isPublicIpAddressIdSpecified()

unsetPublicIpAddressId
```
public void unsetPublicIpAddressId()
```

getPublicIpv6AddressId
```
public Long getPublicIpv6AddressId()
```

setPublicIpv6AddressId

public void setPublicIpv6AddressId(Long publicIpv6AddressId)

isPublicIpv6AddressIdSpecified

public boolean isPublicIpv6AddressIdSpecified()

unsetPublicIpv6AddressId

public void unsetPublicIpv6AddressId()

getPublicVlanId
```
public Long getPublicVlanId()
```

setPublicVlanId

public void setPublicVlanId(Long publicVlanId)

isPublicVlanIdSpecified

public boolean isPublicVlanIdSpecified()

unsetPublicVlanId
```
public void unsetPublicVlanId()
```

getStatusId
```
public Long getStatusId()
```

setStatusId

public void setStatusId(Long statusId)

isStatusIdSpecified
```
public boolean isStatusIdSpecified()
```

unsetStatusId
```
public void unsetStatusId()
```

getInsideVlanCount
```
public Long getInsideVlanCount()
```

setInsideVlanCount

public void setInsideVlanCount(Long insideVlanCount)

getMemberCount
```
public Long getMemberCount()
```

setMemberCount

public void setMemberCount(Long memberCount)

asService

public Gateway.Service asService(ApiClient client)

service

public static Gateway.Service service(ApiClient client)

service

public static Gateway.Service service(ApiClient client,
                                      Long id)

Class Gateway

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

account

insideVlans

members

networkFirewall

networkFirewallFlag

privateIpAddress

privateVlan

publicIpAddress

publicIpv6Address

publicVlan

status

accountId

accountIdSpecified

groupNumber

groupNumberSpecified

id

idSpecified

name

nameSpecified

networkSpace

networkSpaceSpecified

privateIpAddressId

privateIpAddressIdSpecified

privateVlanId

privateVlanIdSpecified

publicIpAddressId

publicIpAddressIdSpecified

publicIpv6AddressId

publicIpv6AddressIdSpecified

publicVlanId

publicVlanIdSpecified

statusId

statusIdSpecified

insideVlanCount

memberCount

Constructor Detail

Gateway

Method Detail

getAccount

setAccount

getInsideVlans

getMembers

getNetworkFirewall

setNetworkFirewall

getNetworkFirewallFlag

setNetworkFirewallFlag

getPrivateIpAddress

setPrivateIpAddress

getPrivateVlan

setPrivateVlan

getPublicIpAddress

setPublicIpAddress

getPublicIpv6Address

setPublicIpv6Address

getPublicVlan

setPublicVlan

getStatus

setStatus

getAccountId

setAccountId

isAccountIdSpecified

unsetAccountId

getGroupNumber

setGroupNumber

isGroupNumberSpecified

unsetGroupNumber

getId

setId

isIdSpecified

unsetId

getName