com.softlayer.api.service.resource.Metadata 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.resource;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.resource.metadata.ServiceResource;
import java.util.List;
import java.util.concurrent.Future;
/**
* The Resource Metadata service enables the user to obtain information regarding the resource from which the request originates. Due to the requirement that the request originate from the backend network of the resource, no API key is necessary to perform the request.
*
* The primary use of this service is to allow self-discovery for newly provisioned resources, enabling further automated setup by the user.
*
* @see SoftLayer_Resource_Metadata
*/
@ApiType("SoftLayer_Resource_Metadata")
public class Metadata extends Entity {
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
/**
* The Resource Metadata service enables the user to obtain information regarding the resource from which the request originates. Due to the requirement that the request originate from the backend network of the resource, no API key is necessary to perform the request.
*
* The primary use of this service is to allow self-discovery for newly provisioned resources, enabling further automated setup by the user.
*
* @see SoftLayer_Resource_Metadata
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Resource_Metadata")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resource
*
* @see SoftLayer_Resource_Metadata::getBackendMacAddresses
*/
@ApiMethod(instanceRequired = true)
public List getBackendMacAddresses();
/**
* The getDatacenter method retrieves the name of the datacenter in which the resource is located.
*
* @see SoftLayer_Resource_Metadata::getDatacenter
*/
@ApiMethod(instanceRequired = true)
public String getDatacenter();
/**
* The getDatacenterId retrieves the ID for the datacenter in which the resource is located.
*
* @see SoftLayer_Resource_Metadata::getDatacenterId
*/
@ApiMethod(instanceRequired = true)
public Long getDatacenterId();
/**
* The getDomain method retrieves the hostname for the resource.
*
* @see SoftLayer_Resource_Metadata::getDomain
*/
@ApiMethod(instanceRequired = true)
public String getDomain();
/**
* The getFrontendMacAddresses method retrieves a list of frontend MAC addresses for the resource
*
* @see SoftLayer_Resource_Metadata::getFrontendMacAddresses
*/
@ApiMethod(instanceRequired = true)
public List getFrontendMacAddresses();
/**
* The getFullyQualifiedDomainName method provides the user with a combined return which includes the hostname and domain for the resource. Because this method returns multiple pieces of information, it avoids the need to use multiple methods to return the desired information.
*
* @see SoftLayer_Resource_Metadata::getFullyQualifiedDomainName
*/
@ApiMethod(instanceRequired = true)
public String getFullyQualifiedDomainName();
/**
* The getId getGlobalIdentifier retrieves the globalIdentifier for the resource
*
* @see SoftLayer_Resource_Metadata::getGlobalIdentifier
*/
@ApiMethod(instanceRequired = true)
public String getGlobalIdentifier();
/**
* The getHostname method retrieves the hostname for the resource.
*
* @see SoftLayer_Resource_Metadata::getHostname
*/
@ApiMethod(instanceRequired = true)
public String getHostname();
/**
* The getId method retrieves the ID for the resource
*
* @see SoftLayer_Resource_Metadata::getId
*/
@ApiMethod(instanceRequired = true)
public Long getId();
/**
* The getPrimaryBackendIpAddress method retrieves the primary backend IP address for the resource
*
* @see SoftLayer_Resource_Metadata::getPrimaryBackendIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getPrimaryBackendIpAddress();
/**
* The getPrimaryIpAddress method retrieves the primary IP address for the resource. For resources with a frontend network, the frontend IP address will be returned. For resources that have been provisioned with only a backend network, the backend IP address will be returned, as a frontend address will not exist.
*
* @see SoftLayer_Resource_Metadata::getPrimaryIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getPrimaryIpAddress();
/**
* The getProvisionState method retrieves the provision state of the resource. The provision state may be used to determine when it is considered safe to perform additional setup operations. The method returns 'PROCESSING' to indicate the provision is in progress and 'COMPLETE' when the provision is complete.
*
* @see SoftLayer_Resource_Metadata::getProvisionState
*/
@ApiMethod(instanceRequired = true)
public String getProvisionState();
/**
* The getRouter method will return the router associated with a network component. When the router is redundant, the hostname of the redundant group will be returned, rather than the router hostname.
*
* @see SoftLayer_Resource_Metadata::getRouter
*/
@ApiMethod(instanceRequired = true)
public String getRouter(String macAddress);
/**
* The getServiceResource method retrieves a specific service resource associated with the resource. Service resources are additional resources that may be used by this resource.
*
* @see SoftLayer_Resource_Metadata::getServiceResource
*/
@ApiMethod(instanceRequired = true)
public String getServiceResource(String serviceName, Long index);
/**
* The getServiceResources method retrieves all service resources associated with the resource. Service resources are additional resources that may be used by this resource. The output format is = for each service resource.
*
* @see SoftLayer_Resource_Metadata::getServiceResources
*/
@ApiMethod(instanceRequired = true)
public List getServiceResources();
/**
* The getTags method retrieves all tags associated with the resource. Tags are single keywords assigned to a resource that assist the user in identifying the resource and its roles when performing a simple search. Tags are assigned by any user with access to the resource.
*
* @see SoftLayer_Resource_Metadata::getTags
*/
@ApiMethod(instanceRequired = true)
public List getTags();
/**
* The getUserMetadata method retrieves metadata completed by users who interact with the resource. Metadata gathered using this method is unique to parameters set using the '''setUserMetadata''' method, which must be executed prior to completing this method. User metadata may also be provided while placing an order for a resource.
*
* @see SoftLayer_Resource_Metadata::getUserMetadata
*/
@ApiMethod(instanceRequired = true)
public String getUserMetadata();
/**
* The getVlanIds method returns a list of VLAN IDs for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component.
*
* @see SoftLayer_Resource_Metadata::getVlanIds
*/
@ApiMethod(instanceRequired = true)
public List getVlanIds(String macAddress);
/**
* The getVlans method returns a list of VLAN numbers for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component.
*
* @see SoftLayer_Resource_Metadata::getVlans
*/
@ApiMethod(instanceRequired = true)
public List getVlans(String macAddress);
}
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#getBackendMacAddresses}
*/
public Future> getBackendMacAddresses();
public Future getBackendMacAddresses(ResponseHandler> callback);
/**
* Async version of {@link Service#getDatacenter}
*/
public Future getDatacenter();
public Future getDatacenter(ResponseHandler callback);
/**
* Async version of {@link Service#getDatacenterId}
*/
public Future getDatacenterId();
public Future getDatacenterId(ResponseHandler callback);
/**
* Async version of {@link Service#getDomain}
*/
public Future getDomain();
public Future getDomain(ResponseHandler callback);
/**
* Async version of {@link Service#getFrontendMacAddresses}
*/
public Future> getFrontendMacAddresses();
public Future getFrontendMacAddresses(ResponseHandler> callback);
/**
* Async version of {@link Service#getFullyQualifiedDomainName}
*/
public Future getFullyQualifiedDomainName();
public Future getFullyQualifiedDomainName(ResponseHandler callback);
/**
* Async version of {@link Service#getGlobalIdentifier}
*/
public Future getGlobalIdentifier();
public Future getGlobalIdentifier(ResponseHandler callback);
/**
* Async version of {@link Service#getHostname}
*/
public Future getHostname();
public Future getHostname(ResponseHandler callback);
/**
* Async version of {@link Service#getId}
*/
public Future getId();
public Future getId(ResponseHandler callback);
/**
* Async version of {@link Service#getPrimaryBackendIpAddress}
*/
public Future getPrimaryBackendIpAddress();
public Future getPrimaryBackendIpAddress(ResponseHandler callback);
/**
* Async version of {@link Service#getPrimaryIpAddress}
*/
public Future getPrimaryIpAddress();
public Future getPrimaryIpAddress(ResponseHandler callback);
/**
* Async version of {@link Service#getProvisionState}
*/
public Future getProvisionState();
public Future getProvisionState(ResponseHandler callback);
/**
* Async version of {@link Service#getRouter}
*/
public Future getRouter(String macAddress);
public Future getRouter(String macAddress, ResponseHandler callback);
/**
* Async version of {@link Service#getServiceResource}
*/
public Future getServiceResource(String serviceName, Long index);
public Future getServiceResource(String serviceName, Long index, ResponseHandler callback);
/**
* Async version of {@link Service#getServiceResources}
*/
public Future> getServiceResources();
public Future getServiceResources(ResponseHandler> callback);
/**
* Async version of {@link Service#getTags}
*/
public Future> getTags();
public Future getTags(ResponseHandler> callback);
/**
* Async version of {@link Service#getUserMetadata}
*/
public Future getUserMetadata();
public Future getUserMetadata(ResponseHandler callback);
/**
* Async version of {@link Service#getVlanIds}
*/
public Future> getVlanIds(String macAddress);
public Future getVlanIds(String macAddress, ResponseHandler> callback);
/**
* Async version of {@link Service#getVlans}
*/
public Future> getVlans(String macAddress);
public Future getVlans(String macAddress, ResponseHandler> callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
}
}