Package com.softlayer.api.service.network.storage.hub.cleversafe

Interface Account.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Account

@ApiService("SoftLayer_Network_Storage_Hub_Cleversafe_Account")
public static interface Account.Service
extends Service

This class provides an interface for the management of IBM Cloud Object Storage Accounts and Credentials.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account

Method Summary

Modifier and Type	Method	Description
Account.ServiceAsync	asAsync()	Get an async version of this service
List<Credential>	credentialCreate()	Create credentials for an IBM Cloud Object Storage Account
Boolean	credentialDelete(Credential credential)	Delete a credential
Account	getAccount()	SoftLayer account to which an IBM Cloud Object Storage account belongs to.
List<Account>	getAllObjects()
Item	getBillingItem()	An associated parent billing item which is active.
List<Bucket>	getBuckets()	Get buckets
Item	getCancelledBillingItem()	An associated parent billing item which has been cancelled.
Long	getCapacityUsage()	Returns the capacity usage for an IBM Cloud Object Storage account.
List<String>	getCloudObjectStorageMetrics(String start, String end, String storageLocation, String storageClass, String metrics)	Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements: if 200: [ , ] if not 200: [ , ] { "start": "", "errors": [], "end": "", "resource_type": "account", "warnings": [], "resources": [{"metrics" : [{"name": "retrieval", "value": ""}]}] } Notes: 1) When no data is found for a particular triplet (resource_id, storage_location, storage_class) a JSON element is inserted to the warnings Array.
Long	getCredentialLimit()	Returns credential limits for this IBM Cloud Object Storage account.
List<Credential>	getCredentials()	Credentials used for generating an AWS signature.
List<Endpoint>	getEndpoints(Long accountId)	Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.
List<Endpoint>	getEndpointsWithRefetch(Long accountId, Boolean refetch)	Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.
Object	getMetricTrackingObject()	Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account.
Account	getObject()
String	getUuid()	Unique identifier for an IBM Cloud Object Storage account.
void	setMask(Account.Mask mask)
Account.Mask	withMask()	Use the existing mask on this service or create it if not present
Account.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Account.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Account.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 interface Maskable

withMask

Account.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Account.Mask mask)

credentialCreate

@ApiMethod(instanceRequired=true)
List<Credential> credentialCreate()

Create credentials for an IBM Cloud Object Storage Account

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::credentialCreate

credentialDelete

@ApiMethod(instanceRequired=true)
Boolean credentialDelete(Credential credential)

Delete a credential

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::credentialDelete

getAllObjects

@ApiMethod
List<Account> getAllObjects()

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getAllObjects

getBuckets

@ApiMethod(instanceRequired=true)
List<Bucket> getBuckets()

Get buckets

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getBuckets

getCapacityUsage

@ApiMethod(instanceRequired=true)
Long getCapacityUsage()

Returns the capacity usage for an IBM Cloud Object Storage account.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCapacityUsage

getCloudObjectStorageMetrics

@ApiMethod(instanceRequired=true)
List<String> getCloudObjectStorageMetrics(String start,
                                          String end,
                                          String storageLocation,
                                          String storageClass,
                                          String metrics)

Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements:

if 200:

[ , ]

if not 200:

[ , ]



{ "start": "", "errors": [], "end": "", "resource_type": "account", "warnings": [], "resources": [{"metrics" : [{"name": "retrieval", "value": ""}]}] }

Notes: 1) When no data is found for a particular triplet (resource_id, storage_location, storage_class) a JSON element is inserted to the warnings Array. 2) If all queried triplets find data, only the resources Array will be populated, errors and warnings will remain empty.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCloudObjectStorageMetrics

getCredentialLimit

@ApiMethod(instanceRequired=true)
Long getCredentialLimit()

Returns credential limits for this IBM Cloud Object Storage account.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCredentialLimit

getEndpoints

@ApiMethod(instanceRequired=true)
List<Endpoint> getEndpoints(Long accountId)

Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getEndpoints

getEndpointsWithRefetch

@ApiMethod(instanceRequired=true)
List<Endpoint> getEndpointsWithRefetch(Long accountId,
                                       Boolean refetch)

Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getEndpointsWithRefetch

getObject

@ApiMethod(instanceRequired=true)
Account getObject()

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getObject

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

SoftLayer account to which an IBM Cloud Object Storage account belongs to.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getAccount

getBillingItem

@ApiMethod(instanceRequired=true)
Item getBillingItem()

An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getBillingItem

getCancelledBillingItem

@ApiMethod(instanceRequired=true)
Item getCancelledBillingItem()

An associated parent billing item which has been cancelled.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCancelledBillingItem

getCredentials

@ApiMethod(instanceRequired=true)
List<Credential> getCredentials()

Credentials used for generating an AWS signature. Max of 2.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getCredentials

getMetricTrackingObject

@ApiMethod(instanceRequired=true)
Object getMetricTrackingObject()

Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getMetricTrackingObject

getUuid

@ApiMethod(instanceRequired=true)
String getUuid()

Unique identifier for an IBM Cloud Object Storage account.

See Also:

SoftLayer_Network_Storage_Hub_Cleversafe_Account::getUuid