The callback for a service request.
Construct a ResourceConfigurationV1 object.
Options for the service.
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.
cloud-object-storage.bucket.post_backup_policy
permissions on the source-bucketcloud-object-storage.backup_vault.sync
permissions on the Backup VaultThe parameters to send to the service.
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
.The parameters to send to the service.
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.
cloud-object-storage.backup-vault.post_restore
permissions on the backup-vaultcloud-object-storage.bucket.restore_sync
permissions on the target-bucket.The parameters to send to the service.
Delete a BackupPolicy.
Delete a specific BackupPolicy.
Requires that the user has cloud-object-storage.bucket.delete_backup_policy
permissions on the bucket.
The parameters to send to the service.
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.
The parameters to send to the service.
Disables retries.
Enable retries for unfulfilled requests.
the configuration for retries
Get the instance of the authenticator set on the service.
the Authenticator instance
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.
The parameters to send to the service.
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
.The parameters to send to the service.
Returns metadata for the specified bucket.
Returns metadata for the specified bucket.
The parameters to send to the service.
Get the Axios instance set on the service. All requests will be made using this instance.
Get Restore.
Introspect on a specific restore.
Requires that the user have cloud-object-storage.backup_vault.get_restore
permission on the backup vault.
The parameters to send to the service.
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.
The parameters to send to the service.
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.
The parameters to send to the service.
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.
The parameters to send to the service.
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.
The parameters to send to the service.
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.
The parameters to send to the service.
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.
The parameters to send to the service.
Set the HTTP headers to be sent in every request.
the map of headers to include in requests.
Turn request body compression on or off.
Will turn it on if 'true', off if 'false'.
Set the service URL to send requests to.
the base URL for the service.
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
.The parameters to send to the service.
Make changes to a bucket's configuration.
Updates a bucket using JSON Merge Patch. 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.
The parameters to send to the service.
Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.
the input model object
the function that is applied on the input object
is true
when the input object should be handled as a map
Constructs an instance of ResourceConfigurationV1 with passed in options and external configuration.
Generated using TypeDoc
REST API used to configure Cloud Object Storage buckets. interfaces
API Version: 1.0.0