com.softlayer.api.service.network.subnet.rwhois.Data 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.subnet.rwhois;
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 java.util.GregorianCalendar;
import java.util.concurrent.Future;
/**
* Every SoftLayer customer account has contact information associated with it for reverse WHOIS purposes. An account's RWHOIS data, modeled by the SoftLayer_Network_Subnet_Rwhois_Data data type, is used by SoftLayer's reverse WHOIS server as well as for SWIP transactions. SoftLayer's reverse WHOIS servers respond to WHOIS queries for IP addresses belonging to a customer's servers, returning this RWHOIS data.
*
* A SoftLayer customer's RWHOIS data may not necessarily match their account or portal users' contact information.
*
* @see SoftLayer_Network_Subnet_Rwhois_Data
*/
@ApiType("SoftLayer_Network_Subnet_Rwhois_Data")
public class Data extends Entity {
/**
* The SoftLayer customer account associated with this reverse WHOIS data.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* An email address associated with an account's RWHOIS data that is responsible for responding to network abuse queries about malicious traffic coming from your servers' IP addresses.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String abuseEmail;
public String getAbuseEmail() {
return abuseEmail;
}
public void setAbuseEmail(String abuseEmail) {
abuseEmailSpecified = true;
this.abuseEmail = abuseEmail;
}
protected boolean abuseEmailSpecified;
public boolean isAbuseEmailSpecified() {
return abuseEmailSpecified;
}
public void unsetAbuseEmail() {
abuseEmail = null;
abuseEmailSpecified = false;
}
/**
* An account's RWHOIS data's associated account identifier.
*/
@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 first line of the mailing address associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String address1;
public String getAddress1() {
return address1;
}
public void setAddress1(String address1) {
address1Specified = true;
this.address1 = address1;
}
protected boolean address1Specified;
public boolean isAddress1Specified() {
return address1Specified;
}
public void unsetAddress1() {
address1 = null;
address1Specified = false;
}
/**
* The second line of the mailing address associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String address2;
public String getAddress2() {
return address2;
}
public void setAddress2(String address2) {
address2Specified = true;
this.address2 = address2;
}
protected boolean address2Specified;
public boolean isAddress2Specified() {
return address2Specified;
}
public void unsetAddress2() {
address2 = null;
address2Specified = false;
}
/**
* The city of the mailing address associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String city;
public String getCity() {
return city;
}
public void setCity(String city) {
citySpecified = true;
this.city = city;
}
protected boolean citySpecified;
public boolean isCitySpecified() {
return citySpecified;
}
public void unsetCity() {
city = null;
citySpecified = false;
}
/**
* The company name associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String companyName;
public String getCompanyName() {
return companyName;
}
public void setCompanyName(String companyName) {
companyNameSpecified = true;
this.companyName = companyName;
}
protected boolean companyNameSpecified;
public boolean isCompanyNameSpecified() {
return companyNameSpecified;
}
public void unsetCompanyName() {
companyName = null;
companyNameSpecified = false;
}
/**
* A two-letter abbreviation of the country of the mailing address associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String country;
public String getCountry() {
return country;
}
public void setCountry(String country) {
countrySpecified = true;
this.country = country;
}
protected boolean countrySpecified;
public boolean isCountrySpecified() {
return countrySpecified;
}
public void unsetCountry() {
country = null;
countrySpecified = false;
}
/**
* The date an account's RWHOIS data 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 first name associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String firstName;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
firstNameSpecified = true;
this.firstName = firstName;
}
protected boolean firstNameSpecified;
public boolean isFirstNameSpecified() {
return firstNameSpecified;
}
public void unsetFirstName() {
firstName = null;
firstNameSpecified = false;
}
/**
* An account's RWHOIS data's internal identifier.
*/
@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 last name associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String lastName;
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
lastNameSpecified = true;
this.lastName = lastName;
}
protected boolean lastNameSpecified;
public boolean isLastNameSpecified() {
return lastNameSpecified;
}
public void unsetLastName() {
lastName = null;
lastNameSpecified = false;
}
/**
* The date an account's RWHOIS data 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 postal code of the mailing address associated with an account's RWHOIS data.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String postalCode;
public String getPostalCode() {
return postalCode;
}
public void setPostalCode(String postalCode) {
postalCodeSpecified = true;
this.postalCode = postalCode;
}
protected boolean postalCodeSpecified;
public boolean isPostalCodeSpecified() {
return postalCodeSpecified;
}
public void unsetPostalCode() {
postalCode = null;
postalCodeSpecified = false;
}
/**
* Whether an account's RWHOIS data refers to a private residence or not.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean privateResidenceFlag;
public Boolean getPrivateResidenceFlag() {
return privateResidenceFlag;
}
public void setPrivateResidenceFlag(Boolean privateResidenceFlag) {
privateResidenceFlagSpecified = true;
this.privateResidenceFlag = privateResidenceFlag;
}
protected boolean privateResidenceFlagSpecified;
public boolean isPrivateResidenceFlagSpecified() {
return privateResidenceFlagSpecified;
}
public void unsetPrivateResidenceFlag() {
privateResidenceFlag = null;
privateResidenceFlagSpecified = false;
}
/**
* A two-letter abbreviation of the state of the mailing address associated with an account's RWHOIS data. If an account does not reside in a province then this is typically blank.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String state;
public String getState() {
return state;
}
public void setState(String state) {
stateSpecified = true;
this.state = state;
}
protected boolean stateSpecified;
public boolean isStateSpecified() {
return stateSpecified;
}
public void unsetState() {
state = null;
stateSpecified = false;
}
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());
}
/**
* Every SoftLayer customer account has a RWHOIS record tied to it. This RWHOIS record is used by SoftLayer's Reverse Whois system as well as SoftLayer's Automated SWIP system.
*
* This service allows you to update your stored RWHOIS record. Changing this record automatically updates the RWHOIS record in 24 hours, but does NOT update SWIP data. You will need to use the SWIP service to do that.
*
* @see SoftLayer_Network_Subnet_Rwhois_Data
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Network_Subnet_Rwhois_Data")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable.
*
* @see SoftLayer_Network_Subnet_Rwhois_Data::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Data templateObject);
/**
* getObject retrieves the SoftLayer_Network_Subnet_Rwhois_Data object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Rwhois_Data service.
*
* The best way to get Rwhois Data for an account is through getRhwoisData on the Account service.
*
* @see SoftLayer_Network_Subnet_Rwhois_Data::getObject
*/
@ApiMethod(instanceRequired = true)
public Data getObject();
/**
* The SoftLayer customer account associated with this reverse WHOIS data.
*
* @see SoftLayer_Network_Subnet_Rwhois_Data::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
}
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#editObject}
*/
public Future editObject(Data templateObject);
public Future editObject(Data templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(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 Mask abuseEmail() {
withLocalProperty("abuseEmail");
return this;
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask address1() {
withLocalProperty("address1");
return this;
}
public Mask address2() {
withLocalProperty("address2");
return this;
}
public Mask city() {
withLocalProperty("city");
return this;
}
public Mask companyName() {
withLocalProperty("companyName");
return this;
}
public Mask country() {
withLocalProperty("country");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask firstName() {
withLocalProperty("firstName");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask lastName() {
withLocalProperty("lastName");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask postalCode() {
withLocalProperty("postalCode");
return this;
}
public Mask privateResidenceFlag() {
withLocalProperty("privateResidenceFlag");
return this;
}
public Mask state() {
withLocalProperty("state");
return this;
}
}
}