com.softlayer.api.service.virtual.guest.network.Component Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.virtual.guest.network;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.hardware.Router;
import com.softlayer.api.service.network.Subnet;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.component.Firewall;
import com.softlayer.api.service.network.subnet.IpAddress;
import com.softlayer.api.service.virtual.Guest;
import com.softlayer.api.service.virtual.guest.network.component.IcpBinding;
import com.softlayer.api.service.virtual.network.securitygroup.NetworkComponentBinding;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The virtual guest network component data type presents the structure in which all computing instance network components are presented. Internally, the structure supports various virtualization platforms with no change to external interaction.
*
* A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
*
* @see SoftLayer_Virtual_Guest_Network_Component
*/
@ApiType("SoftLayer_Virtual_Guest_Network_Component")
public class Component extends Entity {
/**
* The computing instance that this network component exists on.
*/
@ApiProperty
protected Guest guest;
public Guest getGuest() {
return guest;
}
public void setGuest(Guest guest) {
this.guest = guest;
}
@ApiProperty
protected Boolean highAvailabilityFirewallFlag;
public Boolean getHighAvailabilityFirewallFlag() {
return highAvailabilityFirewallFlag;
}
public void setHighAvailabilityFirewallFlag(Boolean highAvailabilityFirewallFlag) {
this.highAvailabilityFirewallFlag = highAvailabilityFirewallFlag;
}
@ApiProperty
protected IcpBinding icpBinding;
public IcpBinding getIcpBinding() {
return icpBinding;
}
public void setIcpBinding(IcpBinding icpBinding) {
this.icpBinding = icpBinding;
}
/**
* The records of all IP addresses bound to a computing instance's network component.
*/
@ApiProperty
protected List ipAddressBindings;
public List getIpAddressBindings() {
if (ipAddressBindings == null) {
ipAddressBindings = new ArrayList();
}
return ipAddressBindings;
}
/**
* The upstream network component firewall.
*/
@ApiProperty
protected Firewall networkComponentFirewall;
public Firewall getNetworkComponentFirewall() {
return networkComponentFirewall;
}
public void setNetworkComponentFirewall(Firewall networkComponentFirewall) {
this.networkComponentFirewall = networkComponentFirewall;
}
/**
* The VLAN that a computing instance network component's subnet is associated with.
*/
@ApiProperty
protected Vlan networkVlan;
public Vlan getNetworkVlan() {
return networkVlan;
}
public void setNetworkVlan(Vlan networkVlan) {
this.networkVlan = networkVlan;
}
/**
* A computing instance network component's primary IP address.
*/
@ApiProperty
protected String primaryIpAddress;
public String getPrimaryIpAddress() {
return primaryIpAddress;
}
public void setPrimaryIpAddress(String primaryIpAddress) {
this.primaryIpAddress = primaryIpAddress;
}
@ApiProperty
protected IpAddress primaryIpAddressRecord;
public IpAddress getPrimaryIpAddressRecord() {
return primaryIpAddressRecord;
}
public void setPrimaryIpAddressRecord(IpAddress primaryIpAddressRecord) {
this.primaryIpAddressRecord = primaryIpAddressRecord;
}
/**
* A network component's subnet for its primary IP address
*/
@ApiProperty
protected Subnet primarySubnet;
public Subnet getPrimarySubnet() {
return primarySubnet;
}
public void setPrimarySubnet(Subnet primarySubnet) {
this.primarySubnet = primarySubnet;
}
/**
* A network component's primary IPv6 IP address record.
*/
@ApiProperty
protected IpAddress primaryVersion6IpAddressRecord;
public IpAddress getPrimaryVersion6IpAddressRecord() {
return primaryVersion6IpAddressRecord;
}
public void setPrimaryVersion6IpAddressRecord(IpAddress primaryVersion6IpAddressRecord) {
this.primaryVersion6IpAddressRecord = primaryVersion6IpAddressRecord;
}
/**
* A network component's routers.
*/
@ApiProperty
protected Router router;
public Router getRouter() {
return router;
}
public void setRouter(Router router) {
this.router = router;
}
/**
* The bindings associating security groups to this network component
*/
@ApiProperty
protected List securityGroupBindings;
public List getSecurityGroupBindings() {
if (securityGroupBindings == null) {
securityGroupBindings = new ArrayList();
}
return securityGroupBindings;
}
/**
* A network component's subnets. A subnet is a group of IP addresses
*/
@ApiProperty
protected List subnets;
public List getSubnets() {
if (subnets == null) {
subnets = new ArrayList();
}
return subnets;
}
/**
* The date a computing instance's network component was created.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar createDate;
public GregorianCalendar getCreateDate() {
return createDate;
}
public void setCreateDate(GregorianCalendar createDate) {
createDateSpecified = true;
this.createDate = createDate;
}
protected boolean createDateSpecified;
public boolean isCreateDateSpecified() {
return createDateSpecified;
}
public void unsetCreateDate() {
createDate = null;
createDateSpecified = false;
}
/**
* The unique ID of the [[SoftLayer_Virtual_Guest|computing instance]] that this network component belongs to.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long guestId;
public Long getGuestId() {
return guestId;
}
public void setGuestId(Long guestId) {
guestIdSpecified = true;
this.guestId = guestId;
}
protected boolean guestIdSpecified;
public boolean isGuestIdSpecified() {
return guestIdSpecified;
}
public void unsetGuestId() {
guestId = null;
guestIdSpecified = false;
}
/**
* A computing instance's network component's unique ID.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* A computing instance network component's unique MAC address.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String macAddress;
public String getMacAddress() {
return macAddress;
}
public void setMacAddress(String macAddress) {
macAddressSpecified = true;
this.macAddress = macAddress;
}
protected boolean macAddressSpecified;
public boolean isMacAddressSpecified() {
return macAddressSpecified;
}
public void unsetMacAddress() {
macAddress = null;
macAddressSpecified = false;
}
/**
* A computing instance network component's maximum allowed speed, measured in Mbit per second. ''maxSpeed'' is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer computing instance.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long maxSpeed;
public Long getMaxSpeed() {
return maxSpeed;
}
public void setMaxSpeed(Long maxSpeed) {
maxSpeedSpecified = true;
this.maxSpeed = maxSpeed;
}
protected boolean maxSpeedSpecified;
public boolean isMaxSpeedSpecified() {
return maxSpeedSpecified;
}
public void unsetMaxSpeed() {
maxSpeed = null;
maxSpeedSpecified = false;
}
/**
* The date a computing instance's network component was last modified.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar modifyDate;
public GregorianCalendar getModifyDate() {
return modifyDate;
}
public void setModifyDate(GregorianCalendar modifyDate) {
modifyDateSpecified = true;
this.modifyDate = modifyDate;
}
protected boolean modifyDateSpecified;
public boolean isModifyDateSpecified() {
return modifyDateSpecified;
}
public void unsetModifyDate() {
modifyDate = null;
modifyDateSpecified = false;
}
/**
* A computing instance network component's short name. This is usually ''eth''. Use this in conjunction with the ''port'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String name;
public String getName() {
return name;
}
public void setName(String name) {
nameSpecified = true;
this.name = name;
}
protected boolean nameSpecified;
public boolean isNameSpecified() {
return nameSpecified;
}
public void unsetName() {
name = null;
nameSpecified = false;
}
/**
* A computing instance's network component's [[SoftLayer_Virtual_Network|network]] ID
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long networkId;
public Long getNetworkId() {
return networkId;
}
public void setNetworkId(Long networkId) {
networkIdSpecified = true;
this.networkId = networkId;
}
protected boolean networkIdSpecified;
public boolean isNetworkIdSpecified() {
return networkIdSpecified;
}
public void unsetNetworkId() {
networkId = null;
networkIdSpecified = false;
}
/**
* A computing instance network component's port number. Most computing instances have more than one network interface. The port property separates these interfaces. Use this in conjunction with the ''name'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long port;
public Long getPort() {
return port;
}
public void setPort(Long port) {
portSpecified = true;
this.port = port;
}
protected boolean portSpecified;
public boolean isPortSpecified() {
return portSpecified;
}
public void unsetPort() {
port = null;
portSpecified = false;
}
/**
* A computing instance network component's speed, measured in Mbit per second.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long speed;
public Long getSpeed() {
return speed;
}
public void setSpeed(Long speed) {
speedSpecified = true;
this.speed = speed;
}
protected boolean speedSpecified;
public boolean isSpeedSpecified() {
return speedSpecified;
}
public void unsetSpeed() {
speed = null;
speedSpecified = false;
}
/**
* A computing instance network component's status. This can be one of four possible values: "ACTIVE", "DISABLED", "INACTIVE", or "ABUSE_DISCONNECT". "ACTIVE" network components are enabled and in use on a cloud instance. "ABUSE_DISCONNECT" status components have been administratively disabled by SoftLayer accounting or abuse. "DISABLED" components have been administratively disabled by you, the user. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String status;
public String getStatus() {
return status;
}
public void setStatus(String status) {
statusSpecified = true;
this.status = status;
}
protected boolean statusSpecified;
public boolean isStatusSpecified() {
return statusSpecified;
}
public void unsetStatus() {
status = null;
statusSpecified = false;
}
/**
* A computing instance's network component's unique ID on a virtualization platform.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String uuid;
public String getUuid() {
return uuid;
}
public void setUuid(String uuid) {
uuidSpecified = true;
this.uuid = uuid;
}
protected boolean uuidSpecified;
public boolean isUuidSpecified() {
return uuidSpecified;
}
public void unsetUuid() {
uuid = null;
uuidSpecified = false;
}
/**
* A count of the records of all IP addresses bound to a computing instance's network component.
*/
@ApiProperty
protected Long ipAddressBindingCount;
public Long getIpAddressBindingCount() {
return ipAddressBindingCount;
}
public void setIpAddressBindingCount(Long ipAddressBindingCount) {
this.ipAddressBindingCount = ipAddressBindingCount;
}
/**
* A count of the bindings associating security groups to this network component
*/
@ApiProperty
protected Long securityGroupBindingCount;
public Long getSecurityGroupBindingCount() {
return securityGroupBindingCount;
}
public void setSecurityGroupBindingCount(Long securityGroupBindingCount) {
this.securityGroupBindingCount = securityGroupBindingCount;
}
/**
* A count of a network component's subnets. A subnet is a group of IP addresses
*/
@ApiProperty
protected Long subnetCount;
public Long getSubnetCount() {
return subnetCount;
}
public void setSubnetCount(Long subnetCount) {
this.subnetCount = subnetCount;
}
public Service asService(ApiClient client) {
return service(client, id);
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
/**
* The virtual guest network component service provides a common interface to a [[SoftLayer_Virtual_Guest|computing instance's]] network component. Interaction with various third party APIs is not needed when implementing this service to administer your computing instances.
*
* @see SoftLayer_Virtual_Guest_Network_Component
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Virtual_Guest_Network_Component")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Completely restrict all incoming and outgoing bandwidth traffic to a network component
*
* @see SoftLayer_Virtual_Guest_Network_Component::disable
*/
@ApiMethod(instanceRequired = true)
public Boolean disable();
/**
* Allow incoming and outgoing bandwidth traffic to a network component
*
* @see SoftLayer_Virtual_Guest_Network_Component::enable
*/
@ApiMethod(instanceRequired = true)
public Boolean enable();
/**
* @see SoftLayer_Virtual_Guest_Network_Component::getObject
*/
@ApiMethod(instanceRequired = true)
public Component getObject();
/**
* Issues a ping command and returns the success (true) or failure (false) of the ping command.
*
* @see SoftLayer_Virtual_Guest_Network_Component::isPingable
*/
@ApiMethod(instanceRequired = true)
public Boolean isPingable();
/**
* @see SoftLayer_Virtual_Guest_Network_Component::securityGroupsReady
*/
@ApiMethod(instanceRequired = true)
public Boolean securityGroupsReady();
/**
* The computing instance that this network component exists on.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getGuest
*/
@ApiMethod(instanceRequired = true)
public Guest getGuest();
/**
* @see SoftLayer_Virtual_Guest_Network_Component::getHighAvailabilityFirewallFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHighAvailabilityFirewallFlag();
/**
* @see SoftLayer_Virtual_Guest_Network_Component::getIcpBinding
*/
@ApiMethod(instanceRequired = true)
public IcpBinding getIcpBinding();
/**
* The records of all IP addresses bound to a computing instance's network component.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getIpAddressBindings
*/
@ApiMethod(instanceRequired = true)
public List getIpAddressBindings();
/**
* The upstream network component firewall.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getNetworkComponentFirewall
*/
@ApiMethod(instanceRequired = true)
public Firewall getNetworkComponentFirewall();
/**
* The VLAN that a computing instance network component's subnet is associated with.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getNetworkVlan
*/
@ApiMethod(instanceRequired = true)
public Vlan getNetworkVlan();
/**
* A computing instance network component's primary IP address.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getPrimaryIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getPrimaryIpAddress();
/**
* @see SoftLayer_Virtual_Guest_Network_Component::getPrimaryIpAddressRecord
*/
@ApiMethod(instanceRequired = true)
public IpAddress getPrimaryIpAddressRecord();
/**
* A network component's subnet for its primary IP address
*
* @see SoftLayer_Virtual_Guest_Network_Component::getPrimarySubnet
*/
@ApiMethod(instanceRequired = true)
public Subnet getPrimarySubnet();
/**
* A network component's primary IPv6 IP address record.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getPrimaryVersion6IpAddressRecord
*/
@ApiMethod(instanceRequired = true)
public IpAddress getPrimaryVersion6IpAddressRecord();
/**
* A network component's routers.
*
* @see SoftLayer_Virtual_Guest_Network_Component::getRouter
*/
@ApiMethod(instanceRequired = true)
public Router getRouter();
/**
* The bindings associating security groups to this network component
*
* @see SoftLayer_Virtual_Guest_Network_Component::getSecurityGroupBindings
*/
@ApiMethod(instanceRequired = true)
public List getSecurityGroupBindings();
/**
* A network component's subnets. A subnet is a group of IP addresses
*
* @see SoftLayer_Virtual_Guest_Network_Component::getSubnets
*/
@ApiMethod(instanceRequired = true)
public List getSubnets();
}
public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#disable}
*/
public Future disable();
public Future disable(ResponseHandler callback);
/**
* Async version of {@link Service#enable}
*/
public Future enable();
public Future enable(ResponseHandler callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#isPingable}
*/
public Future isPingable();
public Future isPingable(ResponseHandler callback);
/**
* Async version of {@link Service#securityGroupsReady}
*/
public Future securityGroupsReady();
public Future securityGroupsReady(ResponseHandler callback);
/**
* Async version of {@link Service#getGuest}
*/
public Future getGuest();
/**
* Async callback version of {@link Service#getGuest}
*/
public Future getGuest(ResponseHandler callback);
/**
* Async version of {@link Service#getHighAvailabilityFirewallFlag}
*/
public Future getHighAvailabilityFirewallFlag();
/**
* Async callback version of {@link Service#getHighAvailabilityFirewallFlag}
*/
public Future getHighAvailabilityFirewallFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getIcpBinding}
*/
public Future getIcpBinding();
/**
* Async callback version of {@link Service#getIcpBinding}
*/
public Future getIcpBinding(ResponseHandler callback);
/**
* Async version of {@link Service#getIpAddressBindings}
*/
public Future> getIpAddressBindings();
/**
* Async callback version of {@link Service#getIpAddressBindings}
*/
public Future getIpAddressBindings(ResponseHandler> callback);
/**
* Async version of {@link Service#getNetworkComponentFirewall}
*/
public Future getNetworkComponentFirewall();
/**
* Async callback version of {@link Service#getNetworkComponentFirewall}
*/
public Future getNetworkComponentFirewall(ResponseHandler callback);
/**
* Async version of {@link Service#getNetworkVlan}
*/
public Future getNetworkVlan();
/**
* Async callback version of {@link Service#getNetworkVlan}
*/
public Future getNetworkVlan(ResponseHandler callback);
/**
* Async version of {@link Service#getPrimaryIpAddress}
*/
public Future getPrimaryIpAddress();
/**
* Async callback version of {@link Service#getPrimaryIpAddress}
*/
public Future getPrimaryIpAddress(ResponseHandler callback);
/**
* Async version of {@link Service#getPrimaryIpAddressRecord}
*/
public Future getPrimaryIpAddressRecord();
/**
* Async callback version of {@link Service#getPrimaryIpAddressRecord}
*/
public Future getPrimaryIpAddressRecord(ResponseHandler callback);
/**
* Async version of {@link Service#getPrimarySubnet}
*/
public Future getPrimarySubnet();
/**
* Async callback version of {@link Service#getPrimarySubnet}
*/
public Future getPrimarySubnet(ResponseHandler callback);
/**
* Async version of {@link Service#getPrimaryVersion6IpAddressRecord}
*/
public Future getPrimaryVersion6IpAddressRecord();
/**
* Async callback version of {@link Service#getPrimaryVersion6IpAddressRecord}
*/
public Future getPrimaryVersion6IpAddressRecord(ResponseHandler callback);
/**
* Async version of {@link Service#getRouter}
*/
public Future getRouter();
/**
* Async callback version of {@link Service#getRouter}
*/
public Future getRouter(ResponseHandler callback);
/**
* Async version of {@link Service#getSecurityGroupBindings}
*/
public Future> getSecurityGroupBindings();
/**
* Async callback version of {@link Service#getSecurityGroupBindings}
*/
public Future getSecurityGroupBindings(ResponseHandler> callback);
/**
* Async version of {@link Service#getSubnets}
*/
public Future> getSubnets();
/**
* Async callback version of {@link Service#getSubnets}
*/
public Future getSubnets(ResponseHandler> callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public com.softlayer.api.service.virtual.Guest.Mask guest() {
return withSubMask("guest", com.softlayer.api.service.virtual.Guest.Mask.class);
}
public Mask highAvailabilityFirewallFlag() {
withLocalProperty("highAvailabilityFirewallFlag");
return this;
}
public com.softlayer.api.service.virtual.guest.network.component.IcpBinding.Mask icpBinding() {
return withSubMask("icpBinding", com.softlayer.api.service.virtual.guest.network.component.IcpBinding.Mask.class);
}
public com.softlayer.api.service.virtual.guest.network.component.IpAddress.Mask ipAddressBindings() {
return withSubMask("ipAddressBindings", com.softlayer.api.service.virtual.guest.network.component.IpAddress.Mask.class);
}
public com.softlayer.api.service.network.component.Firewall.Mask networkComponentFirewall() {
return withSubMask("networkComponentFirewall", com.softlayer.api.service.network.component.Firewall.Mask.class);
}
public com.softlayer.api.service.network.Vlan.Mask networkVlan() {
return withSubMask("networkVlan", com.softlayer.api.service.network.Vlan.Mask.class);
}
public Mask primaryIpAddress() {
withLocalProperty("primaryIpAddress");
return this;
}
public com.softlayer.api.service.network.subnet.IpAddress.Mask primaryIpAddressRecord() {
return withSubMask("primaryIpAddressRecord", com.softlayer.api.service.network.subnet.IpAddress.Mask.class);
}
public com.softlayer.api.service.network.Subnet.Mask primarySubnet() {
return withSubMask("primarySubnet", com.softlayer.api.service.network.Subnet.Mask.class);
}
public com.softlayer.api.service.network.subnet.IpAddress.Mask primaryVersion6IpAddressRecord() {
return withSubMask("primaryVersion6IpAddressRecord", com.softlayer.api.service.network.subnet.IpAddress.Mask.class);
}
public com.softlayer.api.service.hardware.Router.Mask router() {
return withSubMask("router", com.softlayer.api.service.hardware.Router.Mask.class);
}
public com.softlayer.api.service.virtual.network.securitygroup.NetworkComponentBinding.Mask securityGroupBindings() {
return withSubMask("securityGroupBindings", com.softlayer.api.service.virtual.network.securitygroup.NetworkComponentBinding.Mask.class);
}
public com.softlayer.api.service.network.Subnet.Mask subnets() {
return withSubMask("subnets", com.softlayer.api.service.network.Subnet.Mask.class);
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask guestId() {
withLocalProperty("guestId");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask macAddress() {
withLocalProperty("macAddress");
return this;
}
public Mask maxSpeed() {
withLocalProperty("maxSpeed");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask name() {
withLocalProperty("name");
return this;
}
public Mask networkId() {
withLocalProperty("networkId");
return this;
}
public Mask port() {
withLocalProperty("port");
return this;
}
public Mask speed() {
withLocalProperty("speed");
return this;
}
public Mask status() {
withLocalProperty("status");
return this;
}
public Mask uuid() {
withLocalProperty("uuid");
return this;
}
public Mask ipAddressBindingCount() {
withLocalProperty("ipAddressBindingCount");
return this;
}
public Mask securityGroupBindingCount() {
withLocalProperty("securityGroupBindingCount");
return this;
}
public Mask subnetCount() {
withLocalProperty("subnetCount");
return this;
}
}
}