com.softlayer.api.service.network.Pod 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.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 java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;
/**
* SoftLayer_Network_Pod refers to a portion of a data center that share a Backend Customer Router (BCR) and usually a front-end counterpart known as a Frontend Customer Router (FCR). A Pod primarily denotes a logical location within the network and the physical aspects that support networks. This is in contrast to representing a specific physical location.
*
* A ``Pod`` is identified by a ``name``, which is unique. A Pod name follows the format 'dddnn.podii', where 'ddd' is a data center code, 'nn' is the data center number, 'pod' is a literal string and 'ii' is a two digit, left-zero- padded number which corresponds to a Backend Customer Router (BCR) of the desired data center. Examples: - dal09.pod01 = Dallas 9, Pod 1 (ie. bcr01)
- sjc01.pod04 = San Jose 1, Pod 4 (ie. bcr04)
- ams01.pod01 = Amsterdam 1, Pod 1 (ie. bcr01)
*
* @see SoftLayer_Network_Pod
*/
@ApiType("SoftLayer_Network_Pod")
public class Pod extends Entity {
/**
* Identifier for this Pod's Backend Customer Router (BCR)
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long backendRouterId;
public Long getBackendRouterId() {
return backendRouterId;
}
public void setBackendRouterId(Long backendRouterId) {
backendRouterIdSpecified = true;
this.backendRouterId = backendRouterId;
}
protected boolean backendRouterIdSpecified;
public boolean isBackendRouterIdSpecified() {
return backendRouterIdSpecified;
}
public void unsetBackendRouterId() {
backendRouterId = null;
backendRouterIdSpecified = false;
}
/**
* Host name of Pod's Backend Customer Router (BCR), e.g. bcr01a.dal09
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String backendRouterName;
public String getBackendRouterName() {
return backendRouterName;
}
public void setBackendRouterName(String backendRouterName) {
backendRouterNameSpecified = true;
this.backendRouterName = backendRouterName;
}
protected boolean backendRouterNameSpecified;
public boolean isBackendRouterNameSpecified() {
return backendRouterNameSpecified;
}
public void unsetBackendRouterName() {
backendRouterName = null;
backendRouterNameSpecified = false;
}
/**
* Property providing a means to filter Pods based on available capabitilies. See [[SoftLayer_Network_Pod/getAllObjects]] to filter for Pods with specific capabilities. See [[SoftLayer_Network_Pod/getCapabilities]] to retrieve capabilities of a specific Pod.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected List capabilities;
public List getCapabilities() {
if (capabilities == null) {
capabilities = new ArrayList();
}
return capabilities;
}
protected boolean capabilitiesSpecified;
public boolean isCapabilitiesSpecified() {
return capabilitiesSpecified;
}
public void unsetCapabilities() {
capabilities = null;
capabilitiesSpecified = false;
}
/**
* Identifier for the Data Center the Pod resides within
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long datacenterId;
public Long getDatacenterId() {
return datacenterId;
}
public void setDatacenterId(Long datacenterId) {
datacenterIdSpecified = true;
this.datacenterId = datacenterId;
}
protected boolean datacenterIdSpecified;
public boolean isDatacenterIdSpecified() {
return datacenterIdSpecified;
}
public void unsetDatacenterId() {
datacenterId = null;
datacenterIdSpecified = false;
}
/**
* Long form name of the data center in which this Pod resides, e.g. Dallas 9
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String datacenterLongName;
public String getDatacenterLongName() {
return datacenterLongName;
}
public void setDatacenterLongName(String datacenterLongName) {
datacenterLongNameSpecified = true;
this.datacenterLongName = datacenterLongName;
}
protected boolean datacenterLongNameSpecified;
public boolean isDatacenterLongNameSpecified() {
return datacenterLongNameSpecified;
}
public void unsetDatacenterLongName() {
datacenterLongName = null;
datacenterLongNameSpecified = false;
}
/**
* Name of data center in which this Pod resides, e.g. dal09
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String datacenterName;
public String getDatacenterName() {
return datacenterName;
}
public void setDatacenterName(String datacenterName) {
datacenterNameSpecified = true;
this.datacenterName = datacenterName;
}
protected boolean datacenterNameSpecified;
public boolean isDatacenterNameSpecified() {
return datacenterNameSpecified;
}
public void unsetDatacenterName() {
datacenterName = null;
datacenterNameSpecified = false;
}
/**
* (optional) Identifier for this Pod's Frontend Customer Router (FCR)
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long frontendRouterId;
public Long getFrontendRouterId() {
return frontendRouterId;
}
public void setFrontendRouterId(Long frontendRouterId) {
frontendRouterIdSpecified = true;
this.frontendRouterId = frontendRouterId;
}
protected boolean frontendRouterIdSpecified;
public boolean isFrontendRouterIdSpecified() {
return frontendRouterIdSpecified;
}
public void unsetFrontendRouterId() {
frontendRouterId = null;
frontendRouterIdSpecified = false;
}
/**
* (optional) Host name of Pod's Frontend Customer Router (FCR), e.g. fcr01a.dal09
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String frontendRouterName;
public String getFrontendRouterName() {
return frontendRouterName;
}
public void setFrontendRouterName(String frontendRouterName) {
frontendRouterNameSpecified = true;
this.frontendRouterName = frontendRouterName;
}
protected boolean frontendRouterNameSpecified;
public boolean isFrontendRouterNameSpecified() {
return frontendRouterNameSpecified;
}
public void unsetFrontendRouterName() {
frontendRouterName = null;
frontendRouterNameSpecified = false;
}
/**
* The unique name of the Pod. See [[SoftLayer_Network_Pod (type)]] for details of the name's construction.
*/
@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;
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
/**
* SoftLayer_Network_Pod refers to a portion of a data center that share a Backend Customer Router (BCR) and usually a front-end counterpart known as a Frontend Customer Router (FCR). A Pod primarily denotes a logical location within the network and the physical aspects that support networks. This is in contrast to representing a specific physical location.
*
* A ``Pod`` is identified by a ``name``, which is unique. A Pod name follows the format 'dddnn.podii', where 'ddd' is a data center code, 'nn' is the data center number, 'pod' is a literal string and 'ii' is a two digit, left-zero- padded number which corresponds to a Backend Customer Router (BCR) of the desired data center. Examples: - dal09.pod01 = Dallas 9, Pod 1 (ie. bcr01)
- sjc01.pod04 = San Jose 1, Pod 4 (ie. bcr04)
- ams01.pod01 = Amsterdam 1, Pod 1 (ie. bcr01)
*
* @see SoftLayer_Network_Pod
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Network_Pod")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Filtering is supported for ``datacenterName`` and ``capabilities``. When filtering on capabilities, use the ``in`` operation. Pods fulfilling all capabilities provided will be returned. ``datacenterName`` represents an operation against ``SoftLayer_Location_Datacenter.name`, such as dal05 when referring to Dallas 5.
*
* ```Examples:```
*
* List Pods in a specific datacenter. datacenterName.operation = 'dal06'
*
* List Pods in a geographical area. datacenterName.operation = '^= dal'
*
* List Pods in a region fulfilling capabilities. datacenterName.operation = '^= dal' capabilities.operation = 'in' capabilities.options = [ { name = data, value = [SOME_CAPABILITY, ANOTHER_CAPABILITY] } ]
*
* @see SoftLayer_Network_Pod::getAllObjects
*/
@ApiMethod
public List getAllObjects();
/**
* Provides the list of capabilities a Pod fulfills. See [[SoftLayer_Network_Pod/listCapabilities]] for more information on capabilities.
*
* @see SoftLayer_Network_Pod::getCapabilities
*/
@ApiMethod(instanceRequired = true)
public List getCapabilities();
/**
* Set the initialization parameter to the ``name`` of the Pod to retrieve.
*
* @see SoftLayer_Network_Pod::getObject
*/
@ApiMethod(instanceRequired = true)
public Pod getObject();
/**
* A capability is simply a string literal that denotes the availability of a feature. Capabilities are generally self describing, but any additional details concerning the implications of a capability will be documented elsewhere; usually by the Service or Operation related to it.
*
* @see SoftLayer_Network_Pod::listCapabilities
*/
@ApiMethod
public List listCapabilities();
}
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#getAllObjects}
*/
public Future> getAllObjects();
public Future getAllObjects(ResponseHandler> callback);
/**
* Async version of {@link Service#getCapabilities}
*/
public Future> getCapabilities();
public Future getCapabilities(ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#listCapabilities}
*/
public Future> listCapabilities();
public Future listCapabilities(ResponseHandler> callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public Mask backendRouterId() {
withLocalProperty("backendRouterId");
return this;
}
public Mask backendRouterName() {
withLocalProperty("backendRouterName");
return this;
}
public Mask capabilities() {
withLocalProperty("capabilities");
return this;
}
public Mask datacenterId() {
withLocalProperty("datacenterId");
return this;
}
public Mask datacenterLongName() {
withLocalProperty("datacenterLongName");
return this;
}
public Mask datacenterName() {
withLocalProperty("datacenterName");
return this;
}
public Mask frontendRouterId() {
withLocalProperty("frontendRouterId");
return this;
}
public Mask frontendRouterName() {
withLocalProperty("frontendRouterName");
return this;
}
public Mask name() {
withLocalProperty("name");
return this;
}
}
}