Class StorageControlClient (2.39.0-rc)

StorageControl service includes selected control plane operations.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

StorageControlClient(StorageControlClient const &)

Copy and move support

Parameter
Name Description
StorageControlClient const &

StorageControlClient(StorageControlClient &&)

Copy and move support

Parameter
Name Description
StorageControlClient &&

StorageControlClient(std::shared_ptr< StorageControlConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< StorageControlConnection >
opts Options

Operators

operator=(StorageControlClient const &)

Copy and move support

Parameter
Name Description
StorageControlClient const &
Returns
Type Description
StorageControlClient &

operator=(StorageControlClient &&)

Copy and move support

Parameter
Name Description
StorageControlClient &&
Returns
Type Description
StorageControlClient &

Functions

CreateFolder(std::string const &, google::storage::control::v2::Folder const &, std::string const &, Options)

Creates a new folder.

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

Parameters
Name Description
parent std::string const &

Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

folder google::storage::control::v2::Folder const &

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

folder_id std::string const &

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::Folder >

the result of the RPC. The response message type (google.storage.control.v2.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateFolder(google::storage::control::v2::CreateFolderRequest const &, Options)

Creates a new folder.

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

Parameters
Name Description
request google::storage::control::v2::CreateFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.CreateFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::Folder >

the result of the RPC. The response message type (google.storage.control.v2.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteFolder(std::string const &, Options)

Permanently deletes an empty folder.

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

Parameters
Name Description
name std::string const &

Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteFolder(google::storage::control::v2::DeleteFolderRequest const &, Options)

Permanently deletes an empty folder.

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

Parameters
Name Description
request google::storage::control::v2::DeleteFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.DeleteFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

GetFolder(std::string const &, Options)

Returns metadata for the specified folder.

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

Parameters
Name Description
name std::string const &

Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::Folder >

the result of the RPC. The response message type (google.storage.control.v2.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFolder(google::storage::control::v2::GetFolderRequest const &, Options)

Returns metadata for the specified folder.

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

Parameters
Name Description
request google::storage::control::v2::GetFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::Folder >

the result of the RPC. The response message type (google.storage.control.v2.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListFolders(std::string const &, Options)

Retrieves a list of folders.

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

Parameters
Name Description
parent std::string const &

Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::storage::control::v2::Folder >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.storage.control.v2.Folder, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFolders(google::storage::control::v2::ListFoldersRequest, Options)

Retrieves a list of folders.

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

Parameters
Name Description
request google::storage::control::v2::ListFoldersRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.ListFoldersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::storage::control::v2::Folder >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.storage.control.v2.Folder, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

RenameFolder(std::string const &, std::string const &, Options)

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.

Parameters
Name Description
name std::string const &

Required. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}
destination_folder_id std::string const &

Required. The destination folder ID, e.g. foo/bar/.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::storage::control::v2::Folder > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.storage.control.v2.Folder proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RenameFolder(NoAwaitTag, std::string const &, std::string const &, Options)

Renames a source folder to a destination folder.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
destination_folder_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RenameFolder(google::storage::control::v2::RenameFolderRequest const &, Options)

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.

Parameters
Name Description
request google::storage::control::v2::RenameFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.RenameFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::storage::control::v2::Folder > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.storage.control.v2.Folder proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RenameFolder(NoAwaitTag, google::storage::control::v2::RenameFolderRequest const &, Options)

Renames a source folder to a destination folder.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::storage::control::v2::RenameFolderRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RenameFolder(google::longrunning::Operation const &, Options)

Renames a source folder to a destination folder.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::storage::control::v2::Folder > >

GetStorageLayout(std::string const &, Options)

Returns the storage layout configuration for a given bucket.

Parameters
Name Description
name std::string const &

Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::StorageLayout >

the result of the RPC. The response message type (google.storage.control.v2.StorageLayout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetStorageLayout(google::storage::control::v2::GetStorageLayoutRequest const &, Options)

Returns the storage layout configuration for a given bucket.

Parameters
Name Description
request google::storage::control::v2::GetStorageLayoutRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetStorageLayoutRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::StorageLayout >

the result of the RPC. The response message type (google.storage.control.v2.StorageLayout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateManagedFolder(std::string const &, google::storage::control::v2::ManagedFolder const &, std::string const &, Options)

Creates a new managed folder.

Parameters
Name Description
parent std::string const &

Required. Name of the bucket this managed folder belongs to.

managed_folder google::storage::control::v2::ManagedFolder const &

Required. Properties of the managed folder being created. The bucket and managed folder names are specified in the parent and managed_folder_id fields. Populating these fields in managed_folder will result in an error.

managed_folder_id std::string const &

Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::ManagedFolder >

the result of the RPC. The response message type (google.storage.control.v2.ManagedFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateManagedFolder(google::storage::control::v2::CreateManagedFolderRequest const &, Options)

Creates a new managed folder.

Parameters
Name Description
request google::storage::control::v2::CreateManagedFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.CreateManagedFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::ManagedFolder >

the result of the RPC. The response message type (google.storage.control.v2.ManagedFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteManagedFolder(std::string const &, Options)

Permanently deletes an empty managed folder.

Parameters
Name Description
name std::string const &

Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteManagedFolder(google::storage::control::v2::DeleteManagedFolderRequest const &, Options)

Permanently deletes an empty managed folder.

Parameters
Name Description
request google::storage::control::v2::DeleteManagedFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.DeleteManagedFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

GetManagedFolder(std::string const &, Options)

Returns metadata for the specified managed folder.

Parameters
Name Description
name std::string const &

Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::ManagedFolder >

the result of the RPC. The response message type (google.storage.control.v2.ManagedFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetManagedFolder(google::storage::control::v2::GetManagedFolderRequest const &, Options)

Returns metadata for the specified managed folder.

Parameters
Name Description
request google::storage::control::v2::GetManagedFolderRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetManagedFolderRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::ManagedFolder >

the result of the RPC. The response message type (google.storage.control.v2.ManagedFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListManagedFolders(std::string const &, Options)

Retrieves a list of managed folders for a given bucket.

Parameters
Name Description
parent std::string const &

Required. Name of the bucket this managed folder belongs to.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::storage::control::v2::ManagedFolder >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.storage.control.v2.ManagedFolder, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListManagedFolders(google::storage::control::v2::ListManagedFoldersRequest, Options)

Retrieves a list of managed folders for a given bucket.

Parameters
Name Description
request google::storage::control::v2::ListManagedFoldersRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.ListManagedFoldersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::storage::control::v2::ManagedFolder >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.storage.control.v2.ManagedFolder, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateAnywhereCache(std::string const &, google::storage::control::v2::AnywhereCache const &, Options)

Creates an Anywhere Cache instance.

Parameters
Name Description
parent std::string const &

Required. The bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}
anywhere_cache google::storage::control::v2::AnywhereCache const &

Required. Properties of the Anywhere Cache instance being created. The parent bucket name is specified in the parent field. Server uses the default value of ttl or admission_policy if not specified in request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::storage::control::v2::AnywhereCache > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.storage.control.v2.AnywhereCache proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAnywhereCache(NoAwaitTag, std::string const &, google::storage::control::v2::AnywhereCache const &, Options)

Creates an Anywhere Cache instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
anywhere_cache google::storage::control::v2::AnywhereCache const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAnywhereCache(google::storage::control::v2::CreateAnywhereCacheRequest const &, Options)

Creates an Anywhere Cache instance.

Parameters
Name Description
request google::storage::control::v2::CreateAnywhereCacheRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.CreateAnywhereCacheRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::storage::control::v2::AnywhereCache > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.storage.control.v2.AnywhereCache proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAnywhereCache(NoAwaitTag, google::storage::control::v2::CreateAnywhereCacheRequest const &, Options)

Creates an Anywhere Cache instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::storage::control::v2::CreateAnywhereCacheRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAnywhereCache(google::longrunning::Operation const &, Options)

Creates an Anywhere Cache instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::storage::control::v2::AnywhereCache > >

UpdateAnywhereCache(google::storage::control::v2::AnywhereCache const &, google::protobuf::FieldMask const &, Options)

Updates an Anywhere Cache instance.

Mutable fields include ttl and admission_policy.

Parameters
Name Description
anywhere_cache google::storage::control::v2::AnywhereCache const &

Required. The Anywhere Cache instance to be updated.

update_mask google::protobuf::FieldMask const &

Required. List of fields to be updated. Mutable fields of AnywhereCache include ttl and admission_policy.
To specify ALL fields, specify a single field with the value *. Note: We recommend against doing this. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field's value.
Not specifying any fields is an error.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::storage::control::v2::AnywhereCache > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.storage.control.v2.AnywhereCache proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAnywhereCache(NoAwaitTag, google::storage::control::v2::AnywhereCache const &, google::protobuf::FieldMask const &, Options)

Updates an Anywhere Cache instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
anywhere_cache google::storage::control::v2::AnywhereCache const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateAnywhereCache(google::storage::control::v2::UpdateAnywhereCacheRequest const &, Options)

Updates an Anywhere Cache instance.

Mutable fields include ttl and admission_policy.

Parameters
Name Description
request google::storage::control::v2::UpdateAnywhereCacheRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.UpdateAnywhereCacheRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::storage::control::v2::AnywhereCache > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.storage.control.v2.AnywhereCache proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAnywhereCache(NoAwaitTag, google::storage::control::v2::UpdateAnywhereCacheRequest const &, Options)

Updates an Anywhere Cache instance.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::storage::control::v2::UpdateAnywhereCacheRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateAnywhereCache(google::longrunning::Operation const &, Options)

Updates an Anywhere Cache instance.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::storage::control::v2::AnywhereCache > >

DisableAnywhereCache(std::string const &, Options)

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.

Parameters
Name Description
name std::string const &

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DisableAnywhereCache(google::storage::control::v2::DisableAnywhereCacheRequest const &, Options)

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.

Parameters
Name Description
request google::storage::control::v2::DisableAnywhereCacheRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.DisableAnywhereCacheRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PauseAnywhereCache(std::string const &, Options)

Pauses an Anywhere Cache instance.

Parameters
Name Description
name std::string const &

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PauseAnywhereCache(google::storage::control::v2::PauseAnywhereCacheRequest const &, Options)

Pauses an Anywhere Cache instance.

Parameters
Name Description
request google::storage::control::v2::PauseAnywhereCacheRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.PauseAnywhereCacheRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResumeAnywhereCache(std::string const &, Options)

Resumes a disabled or paused Anywhere Cache instance.

Parameters
Name Description
name std::string const &

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResumeAnywhereCache(google::storage::control::v2::ResumeAnywhereCacheRequest const &, Options)

Resumes a disabled or paused Anywhere Cache instance.

Parameters
Name Description
request google::storage::control::v2::ResumeAnywhereCacheRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.ResumeAnywhereCacheRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAnywhereCache(std::string const &, Options)

Gets an Anywhere Cache instance.

Parameters
Name Description
name std::string const &

Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAnywhereCache(google::storage::control::v2::GetAnywhereCacheRequest const &, Options)

Gets an Anywhere Cache instance.

Parameters
Name Description
request google::storage::control::v2::GetAnywhereCacheRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetAnywhereCacheRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::AnywhereCache >

the result of the RPC. The response message type (google.storage.control.v2.AnywhereCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListAnywhereCaches(std::string const &, Options)

Lists Anywhere Cache instances for a given bucket.

Parameters
Name Description
parent std::string const &

Required. The bucket to which this cache belongs.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::storage::control::v2::AnywhereCache >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.storage.control.v2.AnywhereCache, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAnywhereCaches(google::storage::control::v2::ListAnywhereCachesRequest, Options)

Lists Anywhere Cache instances for a given bucket.

Parameters
Name Description
request google::storage::control::v2::ListAnywhereCachesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.ListAnywhereCachesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::storage::control::v2::AnywhereCache >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.storage.control.v2.AnywhereCache, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetProjectIntelligenceConfig(std::string const &, Options)

Returns the Project scoped singleton IntelligenceConfig resource.

Parameters
Name Description
name std::string const &

Required. The name of the IntelligenceConfig resource associated with your project.
Format: projects/{id}/locations/global/intelligenceConfig
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetProjectIntelligenceConfig(google::storage::control::v2::GetProjectIntelligenceConfigRequest const &, Options)

Returns the Project scoped singleton IntelligenceConfig resource.

Parameters
Name Description
request google::storage::control::v2::GetProjectIntelligenceConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetProjectIntelligenceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateProjectIntelligenceConfig(google::storage::control::v2::IntelligenceConfig const &, google::protobuf::FieldMask const &, Options)

Updates the Project scoped singleton IntelligenceConfig resource.

Parameters
Name Description
intelligence_config google::storage::control::v2::IntelligenceConfig const &

Required. The IntelligenceConfig resource to be updated.

update_mask google::protobuf::FieldMask const &

Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateProjectIntelligenceConfig(google::storage::control::v2::UpdateProjectIntelligenceConfigRequest const &, Options)

Updates the Project scoped singleton IntelligenceConfig resource.

Parameters
Name Description
request google::storage::control::v2::UpdateProjectIntelligenceConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.UpdateProjectIntelligenceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFolderIntelligenceConfig(std::string const &, Options)

Returns the Folder scoped singleton IntelligenceConfig resource.

Parameters
Name Description
name std::string const &

Required. The name of the IntelligenceConfig resource associated with your folder.
Format: folders/{id}/locations/global/intelligenceConfig
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFolderIntelligenceConfig(google::storage::control::v2::GetFolderIntelligenceConfigRequest const &, Options)

Returns the Folder scoped singleton IntelligenceConfig resource.

Parameters
Name Description
request google::storage::control::v2::GetFolderIntelligenceConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetFolderIntelligenceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateFolderIntelligenceConfig(google::storage::control::v2::IntelligenceConfig const &, google::protobuf::FieldMask const &, Options)

Updates the Folder scoped singleton IntelligenceConfig resource.

Parameters
Name Description
intelligence_config google::storage::control::v2::IntelligenceConfig const &

Required. The IntelligenceConfig resource to be updated.

update_mask google::protobuf::FieldMask const &

Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateFolderIntelligenceConfig(google::storage::control::v2::UpdateFolderIntelligenceConfigRequest const &, Options)

Updates the Folder scoped singleton IntelligenceConfig resource.

Parameters
Name Description
request google::storage::control::v2::UpdateFolderIntelligenceConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.UpdateFolderIntelligenceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOrganizationIntelligenceConfig(std::string const &, Options)

Returns the Organization scoped singleton IntelligenceConfig resource.

Parameters
Name Description
name std::string const &

Required. The name of the IntelligenceConfig resource associated with your organization.
Format: organizations/{org_id}/locations/global/intelligenceConfig
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOrganizationIntelligenceConfig(google::storage::control::v2::GetOrganizationIntelligenceConfigRequest const &, Options)

Returns the Organization scoped singleton IntelligenceConfig resource.

Parameters
Name Description
request google::storage::control::v2::GetOrganizationIntelligenceConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.GetOrganizationIntelligenceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateOrganizationIntelligenceConfig(google::storage::control::v2::IntelligenceConfig const &, google::protobuf::FieldMask const &, Options)

Updates the Organization scoped singleton IntelligenceConfig resource.

Parameters
Name Description
intelligence_config google::storage::control::v2::IntelligenceConfig const &

Required. The IntelligenceConfig resource to be updated.

update_mask google::protobuf::FieldMask const &

Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateOrganizationIntelligenceConfig(google::storage::control::v2::UpdateOrganizationIntelligenceConfigRequest const &, Options)

Updates the Organization scoped singleton IntelligenceConfig resource.

Parameters
Name Description
request google::storage::control::v2::UpdateOrganizationIntelligenceConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.storage.control.v2.UpdateOrganizationIntelligenceConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::storage::control::v2::IntelligenceConfig >

the result of the RPC. The response message type (google.storage.control.v2.IntelligenceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.