Interface Metadata.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Metadata
@ApiService("SoftLayer_Resource_Metadata") public static interface Metadata.Service extends Service
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 Also:
- SoftLayer_Resource_Metadata
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Metadata.ServiceAsync
asAsync()
Get an async version of this serviceLong
getAccountId()
The getAccountId retrieves the ID for the account on which the resource is located.List<String>
getBackendMacAddresses()
The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resourceString
getDatacenter()
The getDatacenter method retrieves the name of the datacenter in which the resource is located.Long
getDatacenterId()
The getDatacenterId retrieves the ID for the datacenter in which the resource is located.String
getDomain()
The getDomain method retrieves the hostname for the resource.List<String>
getFrontendMacAddresses()
The getFrontendMacAddresses method retrieves a list of frontend MAC addresses for the resourceString
getFullyQualifiedDomainName()
The getFullyQualifiedDomainName method provides the user with a combined return which includes the hostname and domain for the resource.String
getGlobalIdentifier()
The getId getGlobalIdentifier retrieves the globalIdentifier for the resourceString
getHostname()
The getHostname method retrieves the hostname for the resource.Long
getId()
The getId method retrieves the ID for the resourceString
getPrimaryBackendIpAddress()
The getPrimaryBackendIpAddress method retrieves the primary backend IP address for the resourceString
getPrimaryIpAddress()
The getPrimaryIpAddress method retrieves the primary IP address for the resource.String
getProvisionState()
The getProvisionState method retrieves the provision state of the resource.String
getRouter(String macAddress)
The getRouter method will return the router associated with a network component.String
getServiceResource(String serviceName, Long index)
The getServiceResource method retrieves a specific service resource associated with the resource.List<ServiceResource>
getServiceResources()
The getServiceResources method retrieves all service resources associated with the resource.List<String>
getTags()
The getTags method retrieves all tags associated with the resource.String
getUserMetadata()
The getUserMetadata method retrieves metadata completed by users who interact with the resource.List<Long>
getVlanIds(String macAddress)
The getVlanIds method returns a list of VLAN IDs for the network component matching the provided MAC address associated with the resource.List<Long>
getVlans(String macAddress)
The getVlans method returns a list of VLAN numbers for the network component matching the provided MAC address associated with the resource.void
setMask(Metadata.Mask mask)
Metadata.Mask
withMask()
Use the existing mask on this service or create it if not presentMetadata.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
Metadata.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
Metadata.Mask withNewMask()
Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Metadata.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(Metadata.Mask mask)
-
getAccountId
@ApiMethod Long getAccountId()
The getAccountId retrieves the ID for the account on which the resource is located.
-
getBackendMacAddresses
@ApiMethod List<String> getBackendMacAddresses()
The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resource
-
getDatacenter
@ApiMethod String getDatacenter()
The getDatacenter method retrieves the name of the datacenter in which the resource is located.
-
getDatacenterId
@ApiMethod Long getDatacenterId()
The getDatacenterId retrieves the ID for the datacenter in which the resource is located.
-
getDomain
@ApiMethod String getDomain()
The getDomain method retrieves the hostname for the resource.- See Also:
- SoftLayer_Resource_Metadata::getDomain
-
getFrontendMacAddresses
@ApiMethod List<String> getFrontendMacAddresses()
The getFrontendMacAddresses method retrieves a list of frontend MAC addresses for the resource
-
getFullyQualifiedDomainName
@ApiMethod String getFullyQualifiedDomainName()
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.
-
getGlobalIdentifier
@ApiMethod String getGlobalIdentifier()
The getId getGlobalIdentifier retrieves the globalIdentifier for the resource
-
getHostname
@ApiMethod String getHostname()
The getHostname method retrieves the hostname for the resource.- See Also:
- SoftLayer_Resource_Metadata::getHostname
-
getId
@ApiMethod Long getId()
The getId method retrieves the ID for the resource- See Also:
- SoftLayer_Resource_Metadata::getId
-
getPrimaryBackendIpAddress
@ApiMethod String getPrimaryBackendIpAddress()
The getPrimaryBackendIpAddress method retrieves the primary backend IP address for the resource
-
getPrimaryIpAddress
@ApiMethod String getPrimaryIpAddress()
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.
-
getProvisionState
@ApiMethod String getProvisionState()
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.
-
getRouter
@ApiMethod String getRouter(String macAddress)
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 Also:
- SoftLayer_Resource_Metadata::getRouter
-
getServiceResource
@ApiMethod String getServiceResource(String serviceName, Long index)
The getServiceResource method retrieves a specific service resource associated with the resource. Service resources are additional resources that may be used by this resource.
-
getServiceResources
@ApiMethod List<ServiceResource> getServiceResources()
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.
-
getTags
@ApiMethod List<String> getTags()
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 Also:
- SoftLayer_Resource_Metadata::getTags
-
getUserMetadata
@ApiMethod String getUserMetadata()
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.
-
getVlanIds
@ApiMethod List<Long> getVlanIds(String macAddress)
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 Also:
- SoftLayer_Resource_Metadata::getVlanIds
-
getVlans
@ApiMethod List<Long> getVlans(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 Also:
- SoftLayer_Resource_Metadata::getVlans
-
-