com.ibm.cloud.objectstorage.config.resource_configuration.v1

Class ResourceConfiguration

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.objectstorage.config.resource_configuration.v1.ResourceConfiguration

public class ResourceConfiguration
extends com.ibm.cloud.sdk.core.service.BaseService

REST API used to configure Cloud Object Storage buckets. API Version: 1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVICE_NAME Default service name used when configuring the `ResourceConfiguration` client.
static java.lang.String	DEFAULT_SERVICE_URL Default service endpoint URL.

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
ResourceConfiguration(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `ResourceConfiguration` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy>	createBackupPolicy(CreateBackupPolicyOptions createBackupPolicyOptions) Add a new backup policy to the COS Bucket.
com.ibm.cloud.sdk.core.http.ServiceCall<BackupVault>	createBackupVault(CreateBackupVaultOptions createBackupVaultOptions) create a BackupVault.
com.ibm.cloud.sdk.core.http.ServiceCall<Restore>	createRestore(CreateRestoreOptions createRestoreOptions) Initiate a Restore.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteBackupPolicy(DeleteBackupPolicyOptions deleteBackupPolicyOptions) Delete a BackupPolicy.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteBackupVault(DeleteBackupVaultOptions deleteBackupVaultOptions) Delete an empty Backup Vault.
com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy>	getBackupPolicy(GetBackupPolicyOptions getBackupPolicyOptions) Get BackupPolicy.
com.ibm.cloud.sdk.core.http.ServiceCall<BackupVault>	getBackupVault(GetBackupVaultOptions getBackupVaultOptions) get the config for a Backup Vault.
com.ibm.cloud.sdk.core.http.ServiceCall<Bucket>	getBucketConfig(GetBucketConfigOptions getBucketConfigOptions) Returns metadata for the specified bucket.
com.ibm.cloud.sdk.core.http.ServiceCall<Restore>	getRestore(GetRestoreOptions getRestoreOptions) Get Restore.
com.ibm.cloud.sdk.core.http.ServiceCall<RecoveryRange>	getSourceResourceRecoveryRange(GetSourceResourceRecoveryRangeOptions getSourceResourceRecoveryRangeOptions) get RecoveryRange info.
com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyCollection>	listBackupPolicies(ListBackupPoliciesOptions listBackupPoliciesOptions) List BackupPolicies.
com.ibm.cloud.sdk.core.http.ServiceCall<BackupVaultCollection>	listBackupVaults(ListBackupVaultsOptions listBackupVaultsOptions) list BackupVaults.
com.ibm.cloud.sdk.core.http.ServiceCall<RecoveryRangeCollection>	listRecoveryRanges(ListRecoveryRangesOptions listRecoveryRangesOptions) List RecoveryRanges on a backup vault.
com.ibm.cloud.sdk.core.http.ServiceCall<RestoreCollection>	listRestores(ListRestoresOptions listRestoresOptions) List Restores.
static ResourceConfiguration	newInstance() Class method which constructs an instance of the `ResourceConfiguration` client.
static ResourceConfiguration	newInstance(java.lang.String serviceName) Class method which constructs an instance of the `ResourceConfiguration` client.
com.ibm.cloud.sdk.core.http.ServiceCall<RecoveryRange>	patchSourceResourceRecoveryRange(PatchSourceResourceRecoveryRangeOptions patchSourceResourceRecoveryRangeOptions) patch RecoveryRange info.
com.ibm.cloud.sdk.core.http.ServiceCall<BackupVault>	updateBackupVault(UpdateBackupVaultOptions updateBackupVaultOptions) Update the config on a Backup Vault.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	updateBucketConfig(UpdateBucketConfigOptions updateBucketConfigOptions) Make changes to a bucket's configuration.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureHttpClient, configureService, constructServiceUrl, constructServiceURL, createServiceCall, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final java.lang.String DEFAULT_SERVICE_NAME

Default service name used when configuring the `ResourceConfiguration` client.

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final java.lang.String DEFAULT_SERVICE_URL

Default service endpoint URL.

See Also:

Constant Field Values

Constructor Detail

ResourceConfiguration

public ResourceConfiguration(java.lang.String serviceName,
                             com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `ResourceConfiguration` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static ResourceConfiguration newInstance()

Class method which constructs an instance of the `ResourceConfiguration` client. The default service name is used to configure the client instance.

Returns:

an instance of the `ResourceConfiguration` client using external configuration

newInstance

public static ResourceConfiguration newInstance(java.lang.String serviceName)

Class method which constructs an instance of the `ResourceConfiguration` client. The specified service name is used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `ResourceConfiguration` client using external configuration

createBackupPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy> createBackupPolicy(CreateBackupPolicyOptions createBackupPolicyOptions)

Add a new backup policy to the COS Bucket. Attach a new Backup Policy on a bucket. This request results in the creation of a single, new RecoveryRange on the destination BackupVault. Deletion and re-creation of a BackupPolicy to the same BackupVault destination will generate a new RecoveryRange. The following shall be validated. Any failure to validate shall cause a HTTP 400 to be returned. * the user has `cloud-object-storage.bucket.post_backup_policy` permissions on the source-bucket * the source-bucket must have `cloud-object-storage.backup_vault.sync` permissions on the Backup Vault * the source-bucket must have versioning-on * the Backup Vault must exist and be able to be contacted by the source-bucket * the source-bucket must not have an existing BackupPolicy targeting the Backup Vault * the source-bucket must not have a BackupPolicy with the same policy_name * the source-bucket must have fewer than 3 total BackupPolicies.

Parameters:

createBackupPolicyOptions - the CreateBackupPolicyOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupPolicy

listBackupPolicies

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyCollection> listBackupPolicies(ListBackupPoliciesOptions listBackupPoliciesOptions)

List BackupPolicies. Get all backup policies on a bucket. Requires that the user has `cloud-object-storage.bucket.list_backup_policies` permissions on the source bucket. This request generates the "cloud-object-storage.bucket-backup-policy.list" ActivityTracking event.

Parameters:

listBackupPoliciesOptions - the ListBackupPoliciesOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupPolicyCollection

getBackupPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy> getBackupPolicy(GetBackupPolicyOptions getBackupPolicyOptions)

Get BackupPolicy. Read a specific backup policy on a bucket. Requires that the user has `cloud-object-storage.bucket.get_backup_policy` permissions on the bucket.

Parameters:

getBackupPolicyOptions - the GetBackupPolicyOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupPolicy

deleteBackupPolicy

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteBackupPolicy(DeleteBackupPolicyOptions deleteBackupPolicyOptions)

Delete a BackupPolicy. Delete a specific BackupPolicy. Requires that the user has `cloud-object-storage.bucket.delete_backup_policy` permissions on the bucket.

Parameters:

deleteBackupPolicyOptions - the DeleteBackupPolicyOptions containing the options for the call

Returns:

a ServiceCall with a void result

listBackupVaults

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupVaultCollection> listBackupVaults(ListBackupVaultsOptions listBackupVaultsOptions)

list BackupVaults. Returns a list of BackupVault CRNs owned by the account. Requires that the user has `cloud-object-storage.backup_vault.list_account_backup_vaults` permissions for the account.

Parameters:

listBackupVaultsOptions - the ListBackupVaultsOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupVaultCollection

createBackupVault

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupVault> createBackupVault(CreateBackupVaultOptions createBackupVaultOptions)

create a BackupVault. Creates a BackupVault. Requires that the user has `cloud-object-storage.backup_vault.post_backup_vault` permissions for the account. Certain fields will be returned only if the user has specific permissions: - `activity_tracking` requires `cloud-object-storage.backup_vault.put_activity_tracking` - `metrics_monitoring` requires `cloud-object-storage.backup_vault.put_metrics_monitoring`.

Parameters:

createBackupVaultOptions - the CreateBackupVaultOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupVault

getBackupVault

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupVault> getBackupVault(GetBackupVaultOptions getBackupVaultOptions)

get the config for a Backup Vault. Gets configuration information for a Backup Vault. Requires that the user has `cloud-object-storage.backup_vault.get_basic` permissions on the backup vault. Certain fields will be returned only if the user has specific permissions: - `activity_tracking` requires `cloud-object-storage.backup_vault.get_activity_tracking` - `metrics_monitoring` requires `cloud-object-storage.backup_vault.get_metrics_monitoring` - `sse_kp_customer_root_key_crn` requires `cloud-object-storage.backup_vault.get_crk_id`.

Parameters:

getBackupVaultOptions - the GetBackupVaultOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupVault

updateBackupVault

public com.ibm.cloud.sdk.core.http.ServiceCall<BackupVault> updateBackupVault(UpdateBackupVaultOptions updateBackupVaultOptions)

Update the config on a Backup Vault. Update the Backup Vault config via JSON Merge Patch update semantics. In particular, note that providing an empty object (`{}`) to either field in the request body will remove any existing configuration. Requires that the user have specific permissions depending on what is being changed: - `activity_tracking` requires `cloud-object-storage.backup_vault.put_activity_tracking` - `metrics_monitoring` requires `cloud-object-storage.backup_vault.put_metrics_monitoring`.

Parameters:

updateBackupVaultOptions - the UpdateBackupVaultOptions containing the options for the call

Returns:

a ServiceCall with a result of type BackupVault

deleteBackupVault

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteBackupVault(DeleteBackupVaultOptions deleteBackupVaultOptions)

Delete an empty Backup Vault. Delete the Backup Vault. Requires that the BackupVault not contain any RecoveryRanges. Requires that the user has `cloud-object-storage.backup_vault.delete_backup_vault` permissions for the account.

Parameters:

deleteBackupVaultOptions - the DeleteBackupVaultOptions containing the options for the call

Returns:

a ServiceCall with a void result

getBucketConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<Bucket> getBucketConfig(GetBucketConfigOptions getBucketConfigOptions)

Returns metadata for the specified bucket. Returns metadata for the specified bucket.

Parameters:

getBucketConfigOptions - the GetBucketConfigOptions containing the options for the call

Returns:

a ServiceCall with a result of type Bucket

updateBucketConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateBucketConfig(UpdateBucketConfigOptions updateBucketConfigOptions)

Make changes to a bucket's configuration. Updates a bucket using [JSON Merge Patch](https://tools.ietf.org/html/rfc7396). This request is used to add functionality (like an IP access filter) or to update existing parameters. **Primitives are overwritten and replaced in their entirety. It is not possible to append a new (or to delete a specific) value to an array.** Arrays can be cleared by updating the parameter with an empty array `[]`. A `PATCH` operation only updates specified mutable fields. Please don't use `PATCH` trying to update the number of objects in a bucket, any timestamps, or other non-mutable fields.

Parameters:

updateBucketConfigOptions - the UpdateBucketConfigOptions containing the options for the call

Returns:

a ServiceCall with a void result

listRecoveryRanges

public com.ibm.cloud.sdk.core.http.ServiceCall<RecoveryRangeCollection> listRecoveryRanges(ListRecoveryRangesOptions listRecoveryRangesOptions)

List RecoveryRanges on a backup vault. List RecoveryRanges on a backup vault. Lists all available ranges for all source resources by default. The `?source_resource_crn` query parameter will limit the list to only ranges for the specified resource. Requires the user have `cloud-object-storage.backup_vault.list_recovery_ranges` permissions to the Backup Vault.

Parameters:

listRecoveryRangesOptions - the ListRecoveryRangesOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecoveryRangeCollection

getSourceResourceRecoveryRange

public com.ibm.cloud.sdk.core.http.ServiceCall<RecoveryRange> getSourceResourceRecoveryRange(GetSourceResourceRecoveryRangeOptions getSourceResourceRecoveryRangeOptions)

get RecoveryRange info. Get info for a specific RecoveryRange. Requires the user have `cloud-object-storage.backup_vault.get_recovery_range` permissions to the Backup Vault.

Parameters:

getSourceResourceRecoveryRangeOptions - the GetSourceResourceRecoveryRangeOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecoveryRange

patchSourceResourceRecoveryRange

public com.ibm.cloud.sdk.core.http.ServiceCall<RecoveryRange> patchSourceResourceRecoveryRange(PatchSourceResourceRecoveryRangeOptions patchSourceResourceRecoveryRangeOptions)

patch RecoveryRange info. Update a RecoveryRange via JSON-merge-patch semantics. Requires the user have `cloud-object-storage.backup_vault.put_retention` permissions to the Backup Vault. The retention.delete_after_days value may only be extended.

Parameters:

patchSourceResourceRecoveryRangeOptions - the PatchSourceResourceRecoveryRangeOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecoveryRange

createRestore

public com.ibm.cloud.sdk.core.http.ServiceCall<Restore> createRestore(CreateRestoreOptions createRestoreOptions)

Initiate a Restore. Initiates a restore operation against some RecoveryRange to some destination bucket. The following shall be validated. Any failure to validate shall cause a HTTP 400 to be returned. * The specified RecoveryRange must exist * The restore time must be within the RecoveryRange * the user has `cloud-object-storage.backup-vault.post_restore` permissions on the backup-vault * the target-bucket must exist and be able to be contacted by the Backup Vault * target-bucket must have versioning-on * the Backup Vault must have `cloud-object-storage.bucket.restore_sync` permissions on the target-bucket.

Parameters:

createRestoreOptions - the CreateRestoreOptions containing the options for the call

Returns:

a ServiceCall with a result of type Restore

listRestores

public com.ibm.cloud.sdk.core.http.ServiceCall<RestoreCollection> listRestores(ListRestoresOptions listRestoresOptions)

List Restores. List all current and complete restores. Requires that the user have `cloud-object-storage.backup_vault.list_restores` permission on the backup vault.

Parameters:

listRestoresOptions - the ListRestoresOptions containing the options for the call

Returns:

a ServiceCall with a result of type RestoreCollection

getRestore

public com.ibm.cloud.sdk.core.http.ServiceCall<Restore> getRestore(GetRestoreOptions getRestoreOptions)

Get Restore. Introspect on a specific restore. Requires that the user have `cloud-object-storage.backup_vault.get_restore` permission on the backup vault.

Parameters:

getRestoreOptions - the GetRestoreOptions containing the options for the call

Returns:

a ServiceCall with a result of type Restore