Struct StorageControl

Source

pub struct StorageControl { /* private fields */ }

Expand description

Implements a client for the Cloud Storage API.

§Example

let client = StorageControl::builder().build().await?;
// use `client` to make requests to Cloud Storage.

§Configuration

To configure StorageControl use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

with_endpoint(): by default this client uses the global default endpoint (https://storage.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

§Pooling and Cloning

StorageControl holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap StorageControl in an Rc or Arc to reuse it, because it already uses an Arc internally.

§Service Description

The Cloud Storage API allows applications to read and write data through the abstractions of buckets and objects. For a description of these abstractions please see https://cloud.google.com/storage/docs.

This client is used to perform metadata operations, such as creating buckets, deleting objects, listing objects, etc. It does not expose any functions to write or read data in objects.

Resources are named as follows:

Projects are referred to as they are defined by the Resource Manager API, using strings like projects/123456 or projects/my-string-id.
Buckets are named using string names of the form: projects/{project}/buckets/{bucket} For globally unique buckets, _ may be substituted for the project.
Objects are uniquely identified by their name along with the name of the bucket they belong to, as separate strings in this API. For example:
```
bucket = "projects/_/buckets/my-bucket"
object = "my-object/with/a/folder-like/name"
```
Note that object names can contain / characters, which are treated as any other character (no special directory semantics).

Implementations§

Source §

impl StorageControl

Source

pub fn builder() -> ClientBuilder

Returns a builder for StorageControl.

let client = StorageControl::builder().build().await?;

Source

pub fn delete_bucket(&self) -> DeleteBucket

Permanently deletes an empty bucket. The request fails if there are any live or noncurrent objects in the bucket, but the request succeeds if the bucket only contains soft-deleted objects or incomplete uploads, such as ongoing XML API multipart uploads. Does not permanently delete soft-deleted objects.

When this API is used to delete a bucket containing an object that has a soft delete policy enabled, the object becomes soft deleted, and the softDeleteTime and hardDeleteTime properties are set on the object.

Objects and multipart uploads that were in the bucket at the time of deletion are also retained for the specified retention duration. When a soft-deleted bucket reaches the end of its retention duration, it is permanently deleted. The hardDeleteTime of the bucket always equals or exceeds the expiration time of the last soft-deleted object in the bucket.

IAM Permissions:

Requires storage.buckets.delete IAM permission on the bucket.

Source

pub fn get_bucket(&self) -> GetBucket

Returns metadata for the specified bucket.

IAM Permissions:

Requires storage.buckets.get IAM permission on the bucket. Additionally, to return specific bucket metadata, the authenticated user must have the following permissions:

To return the IAM policies: storage.buckets.getIamPolicy
To return the bucket IP filtering rules: storage.buckets.getIpFilter

Source

pub fn create_bucket(&self) -> CreateBucket

Creates a new bucket.

IAM Permissions:

Requires storage.buckets.create IAM permission on the bucket. Additionally, to enable specific bucket features, the authenticated user must have the following permissions:

To enable object retention using the enableObjectRetention query parameter: storage.buckets.enableObjectRetention
To set the bucket IP filtering rules: storage.buckets.setIpFilter

Source

pub fn list_buckets(&self) -> ListBuckets

Retrieves a list of buckets for a given project, ordered lexicographically by name.

IAM Permissions:

Requires storage.buckets.list IAM permission on the bucket. Additionally, to enable specific bucket features, the authenticated user must have the following permissions:

To list the IAM policies: storage.buckets.getIamPolicy
To list the bucket IP filtering rules: storage.buckets.getIpFilter

Source

pub fn lock_bucket_retention_policy(&self) -> LockBucketRetentionPolicy

Permanently locks the retention policy that is currently applied to the specified bucket.

Caution: Locking a bucket is an irreversible action. Once you lock a bucket:

You cannot remove the retention policy from the bucket.
You cannot decrease the retention period for the policy.

Once locked, you must delete the entire bucket in order to remove the bucket’s retention policy. However, before you can delete the bucket, you must delete all the objects in the bucket, which is only possible if all the objects have reached the retention period set by the retention policy.

IAM Permissions:

Requires storage.buckets.update IAM permission on the bucket.

Source

pub fn update_bucket(&self) -> UpdateBucket

Updates a bucket. Changes to the bucket are readable immediately after writing, but configuration changes might take time to propagate. This method supports patch semantics.

IAM Permissions:

Requires storage.buckets.update IAM permission on the bucket. Additionally, to enable specific bucket features, the authenticated user must have the following permissions:

To set bucket IP filtering rules: storage.buckets.setIpFilter
To update public access prevention policies or access control lists (ACLs): storage.buckets.setIamPolicy

Source

pub fn compose_object(&self) -> ComposeObject

Concatenates a list of existing objects into a new object in the same bucket. The existing source objects are unaffected by this operation.

IAM Permissions:

Requires the storage.objects.create and storage.objects.get IAM permissions to use this method. If the new composite object overwrites an existing object, the authenticated user must also have the storage.objects.delete permission. If the request body includes the retention property, the authenticated user must also have the storage.objects.setRetention IAM permission.

Source

pub fn delete_object(&self) -> DeleteObject

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used, or if soft delete is not enabled for the bucket. When this API is used to delete an object from a bucket that has soft delete policy enabled, the object becomes soft deleted, and the softDeleteTime and hardDeleteTime properties are set on the object. This API cannot be used to permanently delete soft-deleted objects. Soft-deleted objects are permanently deleted according to their hardDeleteTime.

You can use the RestoreObject API to restore soft-deleted objects until the soft delete retention period has passed.

IAM Permissions:

Requires storage.objects.delete IAM permission on the bucket.

Source

pub fn restore_object(&self) -> RestoreObject

Restores a soft-deleted object. When a soft-deleted object is restored, a new copy of that object is created in the same bucket and inherits the same metadata as the soft-deleted object. The inherited metadata is the metadata that existed when the original object became soft deleted, with the following exceptions:

The createTime of the new object is set to the time at which the soft-deleted object was restored.
The softDeleteTime and hardDeleteTime values are cleared.
A new generation is assigned and the metageneration is reset to 1.
If the soft-deleted object was in a bucket that had Autoclass enabled, the new object is restored to Standard storage.
The restored object inherits the bucket’s default object ACL, unless copySourceAcl is true.

If a live object using the same name already exists in the bucket and becomes overwritten, the live object becomes a noncurrent object if Object Versioning is enabled on the bucket. If Object Versioning is not enabled, the live object becomes soft deleted.

IAM Permissions:

Requires the following IAM permissions to use this method:

storage.objects.restore
storage.objects.create
storage.objects.delete (only required if overwriting an existing object)
storage.objects.getIamPolicy (only required if projection is full and the relevant bucket has uniform bucket-level access disabled)
storage.objects.setIamPolicy (only required if copySourceAcl is true and the relevant bucket has uniform bucket-level access disabled)

Source

pub fn get_object(&self) -> GetObject

Retrieves object metadata.

IAM Permissions:

Requires storage.objects.get IAM permission on the bucket. To return object ACLs, the authenticated user must also have the storage.objects.getIamPolicy permission.

Source

pub fn update_object(&self) -> UpdateObject

Updates an object’s metadata. Equivalent to JSON API’s storage.objects.patch method.

IAM Permissions:

Requires storage.objects.update IAM permission on the bucket.

Source

pub fn list_objects(&self) -> ListObjects

Retrieves a list of objects matching the criteria.

IAM Permissions:

The authenticated user requires storage.objects.list IAM permission to use this method. To return object ACLs, the authenticated user must also have the storage.objects.getIamPolicy permission.

Source

pub fn rewrite_object(&self) -> RewriteObject

Rewrites a source object to a destination object. Optionally overrides metadata.

Source

pub fn move_object(&self) -> MoveObject

Moves the source object to the destination object in the same bucket. This operation moves a source object to a destination object in the same bucket by renaming the object. The move itself is an atomic transaction, ensuring all steps either complete successfully or no changes are made.

IAM Permissions:

Requires the following IAM permissions to use this method:

storage.objects.move
storage.objects.create
storage.objects.delete (only required if overwriting an existing object)

Source

pub fn create_folder(&self) -> CreateFolder

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Source

pub fn delete_folder(&self) -> DeleteFolder

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Source

pub fn get_folder(&self) -> GetFolder

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Source

pub fn list_folders(&self) -> ListFolders

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

Source

pub fn rename_folder(&self) -> RenameFolder

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn get_storage_layout(&self) -> GetStorageLayout

Returns the storage layout configuration for a given bucket.

Source

pub fn create_managed_folder(&self) -> CreateManagedFolder

Creates a new managed folder.

Source

pub fn delete_managed_folder(&self) -> DeleteManagedFolder

Permanently deletes an empty managed folder.

Source

pub fn get_managed_folder(&self) -> GetManagedFolder

Returns metadata for the specified managed folder.

Source

pub fn list_managed_folders(&self) -> ListManagedFolders

Retrieves a list of managed folders for a given bucket.

Source

pub fn create_anywhere_cache(&self) -> CreateAnywhereCache

Creates an Anywhere Cache instance.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn update_anywhere_cache(&self) -> UpdateAnywhereCache

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_policy.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn disable_anywhere_cache(&self) -> DisableAnywhereCache

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

Source

pub fn pause_anywhere_cache(&self) -> PauseAnywhereCache

Pauses an Anywhere Cache instance.

Source

pub fn resume_anywhere_cache(&self) -> ResumeAnywhereCache

Resumes a disabled or paused Anywhere Cache instance.

Source

pub fn get_anywhere_cache(&self) -> GetAnywhereCache

Gets an Anywhere Cache instance.

Source

pub fn list_anywhere_caches(&self) -> ListAnywhereCaches

Lists Anywhere Cache instances for a given bucket.

Source

pub fn get_project_intelligence_config(&self) -> GetProjectIntelligenceConfig

Returns the Project scoped singleton IntelligenceConfig resource.

Source

pub fn update_project_intelligence_config( &self, ) -> UpdateProjectIntelligenceConfig

Updates the Project scoped singleton IntelligenceConfig resource.

Source

pub fn get_folder_intelligence_config(&self) -> GetFolderIntelligenceConfig

Returns the Folder scoped singleton IntelligenceConfig resource.

Source

pub fn update_folder_intelligence_config( &self, ) -> UpdateFolderIntelligenceConfig

Updates the Folder scoped singleton IntelligenceConfig resource.

Source

pub fn get_organization_intelligence_config( &self, ) -> GetOrganizationIntelligenceConfig

Returns the Organization scoped singleton IntelligenceConfig resource.

Source

pub fn update_organization_intelligence_config( &self, ) -> UpdateOrganizationIntelligenceConfig

Updates the Organization scoped singleton IntelligenceConfig resource.

Source

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the IAM policy for a specified bucket. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

Source

pub fn set_iam_policy(&self) -> SetIamPolicy

Updates an IAM policy for the specified bucket. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

Source

pub fn test_iam_permissions(&self) -> TestIamPermissions

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, projects/_/buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

Source