com.softlayer.api.service.account.regional.registry.Detail 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.account.regional.registry;
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.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.account.regional.registry.detail.Property;
import com.softlayer.api.service.account.regional.registry.detail.Type;
import com.softlayer.api.service.account.rwhois.Handle;
import com.softlayer.api.service.container.Message;
import com.softlayer.api.service.container.network.subnet.registration.TransactionDetails;
import com.softlayer.api.service.network.subnet.registration.Details;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
*
*
*
*
*
*
* @see SoftLayer_Account_Regional_Registry_Detail
*/
@ApiType("SoftLayer_Account_Regional_Registry_Detail")
public class Detail extends Entity {
/**
* The account that this detail object belongs to.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* The associated type of this detail object.
*/
@ApiProperty
protected Type detailType;
public Type getDetailType() {
return detailType;
}
public void setDetailType(Type detailType) {
this.detailType = detailType;
}
/**
* References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.
*/
@ApiProperty
protected List details;
public List getDetails() {
if (details == null) {
details = new ArrayList();
}
return details;
}
/**
* The individual properties that define this detail object's values.
*/
@ApiProperty
protected List properties;
public List getProperties() {
if (properties == null) {
properties = new ArrayList();
}
return properties;
}
/**
* The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.
*/
@ApiProperty
protected Handle regionalInternetRegistryHandle;
public Handle getRegionalInternetRegistryHandle() {
return regionalInternetRegistryHandle;
}
public void setRegionalInternetRegistryHandle(Handle regionalInternetRegistryHandle) {
this.regionalInternetRegistryHandle = regionalInternetRegistryHandle;
}
/**
* The detail object's associated [[SoftLayer_Account|account]] id
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* The date and time the detail object 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 detail object's associated [[SoftLayer_Account_Regional_Registry_Detail_Type|type]] id
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long detailTypeId;
public Long getDetailTypeId() {
return detailTypeId;
}
public void setDetailTypeId(Long detailTypeId) {
detailTypeIdSpecified = true;
this.detailTypeId = detailTypeId;
}
protected boolean detailTypeIdSpecified;
public boolean isDetailTypeIdSpecified() {
return detailTypeIdSpecified;
}
public void unsetDetailTypeId() {
detailTypeId = null;
detailTypeIdSpecified = false;
}
/**
* Unique ID of the detail object
*/
@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;
}
/**
* The date and time the detail object 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;
}
/**
* The detail object's associated [[SoftLayer_Account_Rwhois_Handle|RIR handle]] id
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long regionalInternetRegistryHandleId;
public Long getRegionalInternetRegistryHandleId() {
return regionalInternetRegistryHandleId;
}
public void setRegionalInternetRegistryHandleId(Long regionalInternetRegistryHandleId) {
regionalInternetRegistryHandleIdSpecified = true;
this.regionalInternetRegistryHandleId = regionalInternetRegistryHandleId;
}
protected boolean regionalInternetRegistryHandleIdSpecified;
public boolean isRegionalInternetRegistryHandleIdSpecified() {
return regionalInternetRegistryHandleIdSpecified;
}
public void unsetRegionalInternetRegistryHandleId() {
regionalInternetRegistryHandleId = null;
regionalInternetRegistryHandleIdSpecified = false;
}
/**
* A count of references to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.
*/
@ApiProperty
protected Long detailCount;
public Long getDetailCount() {
return detailCount;
}
public void setDetailCount(Long detailCount) {
this.detailCount = detailCount;
}
/**
* A count of the individual properties that define this detail object's values.
*/
@ApiProperty
protected Long propertyCount;
public Long getPropertyCount() {
return propertyCount;
}
public void setPropertyCount(Long propertyCount) {
this.propertyCount = propertyCount;
}
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());
}
/**
* Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries.
*
* @see SoftLayer_Account_Regional_Registry_Detail
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Account_Regional_Registry_Detail")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* This method will create a new SoftLayer_Account_Regional_Registry_Detail object.
*
* Input - [[SoftLayer_Account_Regional_Registry_Detail (type)|SoftLayer_Account_Regional_Registry_Detail]] detailTypeId The [[SoftLayer_Account_Regional_Registry_Detail_Type|type id]] of this detail object - Required
- Type - integer
regionalInternetRegistryHandleId The id of the [[SoftLayer_Account_Rwhois_Handle|RWhois handle]] object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to. - Optional
- Type - integer
*
* @see SoftLayer_Account_Regional_Registry_Detail::createObject
*/
@ApiMethod
public Detail createObject(Detail templateObject);
/**
* This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.
*
* @see SoftLayer_Account_Regional_Registry_Detail::deleteObject
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteObject();
/**
* This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [[SoftLayer_Account_Regional_Registry_Detail::createObject|createObject]].
*
* @see SoftLayer_Account_Regional_Registry_Detail::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Detail templateObject);
/**
* @see SoftLayer_Account_Regional_Registry_Detail::getObject
*/
@ApiMethod(instanceRequired = true)
public Detail getObject();
/**
* This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as [[SoftLayer_Account_Regional_Registry_Detail_Person]] or [[SoftLayer_Account_Regional_Registry_Detail_Network]]. The registrations should be in the Open or Registration_Complete status.
*
* @see SoftLayer_Account_Regional_Registry_Detail::updateReferencedRegistrations
*/
@ApiMethod(instanceRequired = true)
public TransactionDetails updateReferencedRegistrations();
/**
* Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar.
*
* The person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data
*
* If the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration.
*
* If the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid.
*
* @see SoftLayer_Account_Regional_Registry_Detail::validatePersonForAllRegistrars
*/
@ApiMethod(instanceRequired = true)
public List validatePersonForAllRegistrars();
/**
* The account that this detail object belongs to.
*
* @see SoftLayer_Account_Regional_Registry_Detail::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* The associated type of this detail object.
*
* @see SoftLayer_Account_Regional_Registry_Detail::getDetailType
*/
@ApiMethod(instanceRequired = true)
public Type getDetailType();
/**
* References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.
*
* @see SoftLayer_Account_Regional_Registry_Detail::getDetails
*/
@ApiMethod(instanceRequired = true)
public List getDetails();
/**
* The individual properties that define this detail object's values.
*
* @see SoftLayer_Account_Regional_Registry_Detail::getProperties
*/
@ApiMethod(instanceRequired = true)
public List getProperties();
/**
* The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.
*
* @see SoftLayer_Account_Regional_Registry_Detail::getRegionalInternetRegistryHandle
*/
@ApiMethod(instanceRequired = true)
public Handle getRegionalInternetRegistryHandle();
}
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#createObject}
*/
public Future createObject(Detail templateObject);
public Future createObject(Detail templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#deleteObject}
*/
public Future deleteObject();
public Future deleteObject(ResponseHandler callback);
/**
* Async version of {@link Service#editObject}
*/
public Future editObject(Detail templateObject);
public Future editObject(Detail templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#updateReferencedRegistrations}
*/
public Future updateReferencedRegistrations();
public Future updateReferencedRegistrations(ResponseHandler callback);
/**
* Async version of {@link Service#validatePersonForAllRegistrars}
*/
public Future> validatePersonForAllRegistrars();
public Future validatePersonForAllRegistrars(ResponseHandler> callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(ResponseHandler callback);
/**
* Async version of {@link Service#getDetailType}
*/
public Future getDetailType();
/**
* Async callback version of {@link Service#getDetailType}
*/
public Future getDetailType(ResponseHandler callback);
/**
* Async version of {@link Service#getDetails}
*/
public Future> getDetails();
/**
* Async callback version of {@link Service#getDetails}
*/
public Future getDetails(ResponseHandler> callback);
/**
* Async version of {@link Service#getProperties}
*/
public Future> getProperties();
/**
* Async callback version of {@link Service#getProperties}
*/
public Future getProperties(ResponseHandler> callback);
/**
* Async version of {@link Service#getRegionalInternetRegistryHandle}
*/
public Future getRegionalInternetRegistryHandle();
/**
* Async callback version of {@link Service#getRegionalInternetRegistryHandle}
*/
public Future getRegionalInternetRegistryHandle(ResponseHandler callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public com.softlayer.api.service.Account.Mask account() {
return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
}
public com.softlayer.api.service.account.regional.registry.detail.Type.Mask detailType() {
return withSubMask("detailType", com.softlayer.api.service.account.regional.registry.detail.Type.Mask.class);
}
public com.softlayer.api.service.network.subnet.registration.Details.Mask details() {
return withSubMask("details", com.softlayer.api.service.network.subnet.registration.Details.Mask.class);
}
public com.softlayer.api.service.account.regional.registry.detail.Property.Mask properties() {
return withSubMask("properties", com.softlayer.api.service.account.regional.registry.detail.Property.Mask.class);
}
public com.softlayer.api.service.account.rwhois.Handle.Mask regionalInternetRegistryHandle() {
return withSubMask("regionalInternetRegistryHandle", com.softlayer.api.service.account.rwhois.Handle.Mask.class);
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask detailTypeId() {
withLocalProperty("detailTypeId");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask regionalInternetRegistryHandleId() {
withLocalProperty("regionalInternetRegistryHandleId");
return this;
}
public Mask detailCount() {
withLocalProperty("detailCount");
return this;
}
public Mask propertyCount() {
withLocalProperty("propertyCount");
return this;
}
}
}