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_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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
destination_folder_id |
std::string const &
Required. The destination folder ID, e.g. |
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 |
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 |
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 |
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 > > |
|
DeleteFolderRecursive(std::string const &, Options)
Deletes a folder recursively.
This operation is only applicable to a hierarchical namespace enabled bucket.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. Name of the folder being deleted, however all of its contents will be deleted too. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::DeleteFolderRecursiveMetadata > > |
A |
DeleteFolderRecursive(NoAwaitTag, std::string const &, Options)
Deletes a folder recursively.
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 &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteFolderRecursive(google::storage::control::v2::DeleteFolderRecursiveRequest const &, Options)
Deletes a folder recursively.
This operation is only applicable to a hierarchical namespace enabled bucket.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::DeleteFolderRecursiveRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::DeleteFolderRecursiveMetadata > > |
A |
DeleteFolderRecursive(NoAwaitTag, google::storage::control::v2::DeleteFolderRecursiveRequest const &, Options)
Deletes a folder recursively.
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::DeleteFolderRecursiveRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteFolderRecursive(google::longrunning::Operation const &, Options)
Deletes a folder recursively.
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::DeleteFolderRecursiveMetadata > > |
|
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: |
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 |
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 |
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 |
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 |
managed_folder_id |
std::string const &
Required. The name of the managed folder. It uses a single |
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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
UpdateManagedFolder(google::storage::control::v2::ManagedFolder const &, google::protobuf::FieldMask const &, Options)
Updates a managed folder.
Currently, this RPC only supports updating the rapid_cache_config field.
| Parameters | |
|---|---|
| Name | Description |
managed_folder |
google::storage::control::v2::ManagedFolder const &
Required. Properties of the managed folder being updated. Currently, this RPC only supports updating the |
update_mask |
google::protobuf::FieldMask const &
Optional. Update mask for managed_folder. Currently, this RPC only supports updating the |
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 |
UpdateManagedFolder(google::storage::control::v2::UpdateManagedFolderRequest const &, Options)
Updates a managed folder.
Currently, this RPC only supports updating the rapid_cache_config field.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::UpdateManagedFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
CreateRapidCache(std::string const &, google::storage::control::v2::RapidCache const &, Options)
Creates a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The bucket to which this cache belongs. Format: |
rapid_cache |
google::storage::control::v2::RapidCache const &
Required. The RapidCache to create. Default values for ingest_on_write, ttl and admission_policy will be applied if not specified in the request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::RapidCache > > |
A |
CreateRapidCache(NoAwaitTag, std::string const &, google::storage::control::v2::RapidCache const &, Options)
Creates a Rapid 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 &
|
rapid_cache |
google::storage::control::v2::RapidCache const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateRapidCache(google::storage::control::v2::CreateRapidCacheRequest const &, Options)
Creates a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::CreateRapidCacheRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::RapidCache > > |
A |
CreateRapidCache(NoAwaitTag, google::storage::control::v2::CreateRapidCacheRequest const &, Options)
Creates a Rapid 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::CreateRapidCacheRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateRapidCache(google::longrunning::Operation const &, Options)
Creates a Rapid 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::RapidCache > > |
|
UpdateRapidCache(google::storage::control::v2::RapidCache const &, google::protobuf::FieldMask const &, Options)
Updates a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
rapid_cache |
google::storage::control::v2::RapidCache const &
Required. The RapidCache to update. |
update_mask |
google::protobuf::FieldMask const &
Required. List of fields to be updated. Mutable fields of RapidCache include |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::RapidCache > > |
A |
UpdateRapidCache(NoAwaitTag, google::storage::control::v2::RapidCache const &, google::protobuf::FieldMask const &, Options)
Updates a Rapid 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
|
rapid_cache |
google::storage::control::v2::RapidCache const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateRapidCache(google::storage::control::v2::UpdateRapidCacheRequest const &, Options)
Updates a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::UpdateRapidCacheRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::RapidCache > > |
A |
UpdateRapidCache(NoAwaitTag, google::storage::control::v2::UpdateRapidCacheRequest const &, Options)
Updates a Rapid 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::UpdateRapidCacheRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateRapidCache(google::longrunning::Operation const &, Options)
Updates a Rapid 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::RapidCache > > |
|
DisableRapidCache(std::string const &, Options)
Disables a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name field in the request should be: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::RapidCache > > |
A |
DisableRapidCache(NoAwaitTag, std::string const &, Options)
Disables a Rapid 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
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DisableRapidCache(google::storage::control::v2::DisableRapidCacheRequest const &, Options)
Disables a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::DisableRapidCacheRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::storage::control::v2::RapidCache > > |
A |
DisableRapidCache(NoAwaitTag, google::storage::control::v2::DisableRapidCacheRequest const &, Options)
Disables a Rapid 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::DisableRapidCacheRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DisableRapidCache(google::longrunning::Operation const &, Options)
Disables a Rapid 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::RapidCache > > |
|
GetRapidCache(std::string const &, Options)
Gets a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name field in the request should be: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::RapidCache > |
the result of the RPC. The response message type (google.storage.control.v2.RapidCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRapidCache(google::storage::control::v2::GetRapidCacheRequest const &, Options)
Gets a Rapid Cache instance.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::GetRapidCacheRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::RapidCache > |
the result of the RPC. The response message type (google.storage.control.v2.RapidCache) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListRapidCaches(std::string const &, Options)
Lists Rapid 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::RapidCache > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRapidCaches(google::storage::control::v2::ListRapidCachesRequest, Options)
Lists Rapid Cache instances for a given bucket.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::ListRapidCachesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::RapidCache > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetProjectIntelligenceConfig(std::string const &, Options)
Returns the Project scoped singleton IntelligenceConfig resource.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the |
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 |
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 |
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 |
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 |
update_mask |
google::protobuf::FieldMask const &
Required. The |
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 |
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 |
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 |
GetFolderIntelligenceConfig(std::string const &, Options)
Returns the Folder scoped singleton IntelligenceConfig resource.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the |
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 |
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 |
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 |
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 |
update_mask |
google::protobuf::FieldMask const &
Required. The |
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 |
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 |
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 |
GetOrganizationIntelligenceConfig(std::string const &, Options)
Returns the Organization scoped singleton IntelligenceConfig resource.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the |
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 |
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 |
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 |
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 |
update_mask |
google::protobuf::FieldMask const &
Required. The |
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 |
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 |
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 |
GetIamPolicy(std::string const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
resource |
std::string const &
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(std::string const &, google::iam::v1::Policy const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
resource |
std::string const &
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
google::iam::v1::Policy const &
REQUIRED: The complete policy to be applied to the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(std::string const &, IamUpdater const &, Options)
Updates the IAM policy for resource using an optimistic concurrency control loop.
The loop fetches the current policy for resource, and passes it to updater, which should return the new policy. This new policy should use the current etag so that the read-modify-write cycle can detect races and rerun the update when there is a mismatch. If the new policy does not have an etag, the existing policy will be blindly overwritten. If updater does not yield a policy, the control loop is terminated and kCancelled is returned.
| Parameters | |
|---|---|
| Name | Description |
resource |
std::string const &
Required. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
updater |
IamUpdater const &
Required. Functor to map the current policy to a new one. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
google::iam::v1::Policy |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(std::string const &, std::vector< std::string > const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
resource |
std::string const &
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
std::vector< std::string > const &
The set of permissions to check for the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
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.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIntelligenceFinding(std::string const &, Options)
Gets the IntelligenceFinding for a project.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::IntelligenceFinding > |
the result of the RPC. The response message type (google.storage.control.v2.IntelligenceFinding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIntelligenceFinding(google::storage::control::v2::GetIntelligenceFindingRequest const &, Options)
Gets the IntelligenceFinding for a project.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::GetIntelligenceFindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::IntelligenceFinding > |
the result of the RPC. The response message type (google.storage.control.v2.IntelligenceFinding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListIntelligenceFindings(std::string const &, Options)
Lists the IntelligenceFinding resources for the specified the project.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::IntelligenceFinding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListIntelligenceFindings(google::storage::control::v2::ListIntelligenceFindingsRequest, Options)
Lists the IntelligenceFinding resources for the specified the project.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::ListIntelligenceFindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::IntelligenceFinding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SummarizeIntelligenceFindings(std::string const &, Options)
Summarizes the intelligence findings for the specified scope (organization, folder or project).
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The scope to summarize the findings for. Format:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::FindingSummary > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SummarizeIntelligenceFindings(google::storage::control::v2::SummarizeIntelligenceFindingsRequest, Options)
Summarizes the intelligence findings for the specified scope (organization, folder or project).
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::SummarizeIntelligenceFindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::FindingSummary > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetIntelligenceFindingRevision(std::string const &, Options)
Gets the IntelligenceFindingRevision resource.
Format:
projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}/revisions/{revision}
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the |
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::IntelligenceFindingRevision > |
the result of the RPC. The response message type (google.storage.control.v2.IntelligenceFindingRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIntelligenceFindingRevision(google::storage::control::v2::GetIntelligenceFindingRevisionRequest const &, Options)
Gets the IntelligenceFindingRevision resource.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::GetIntelligenceFindingRevisionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::IntelligenceFindingRevision > |
the result of the RPC. The response message type (google.storage.control.v2.IntelligenceFindingRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListIntelligenceFindingRevisions(std::string const &, Options)
Lists all the revisions of an IntelligenceFinding resource.
Format:
projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent of the |
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::IntelligenceFindingRevision > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListIntelligenceFindingRevisions(google::storage::control::v2::ListIntelligenceFindingRevisionsRequest, Options)
Lists all the revisions of an IntelligenceFinding resource.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::ListIntelligenceFindingRevisionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::storage::control::v2::IntelligenceFindingRevision > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ViewObjectFullContext(std::string const &, std::string const &, Options)
Retrieves the full content of an object context, including its key, value, and any associated extended data for a given context key.
Object contexts can optionally contain extended data. If an object context contains extended data, the metadata payload structure will contain only its type URL. To retrieve the full extended data, call this method.
Returns the complete representation of the context as an ObjectFullContext.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the object. Format: |
context_key |
std::string const &
Required. The key of the object context to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::ObjectFullContext > |
the result of the RPC. The response message type (google.storage.control.v2.ObjectFullContext) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ViewObjectFullContext(std::string const &, std::int64_t, std::string const &, Options)
Retrieves the full content of an object context, including its key, value, and any associated extended data for a given context key.
Object contexts can optionally contain extended data. If an object context contains extended data, the metadata payload structure will contain only its type URL. To retrieve the full extended data, call this method.
Returns the complete representation of the context as an ObjectFullContext.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the object. Format: |
generation |
std::int64_t
Optional. If present, selects a specific revision of this object (as opposed to the latest version, the default). |
context_key |
std::string const &
Required. The key of the object context to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::ObjectFullContext > |
the result of the RPC. The response message type (google.storage.control.v2.ObjectFullContext) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ViewObjectFullContext(google::storage::control::v2::ViewObjectFullContextRequest const &, Options)
Retrieves the full content of an object context, including its key, value, and any associated extended data for a given context key.
Object contexts can optionally contain extended data. If an object context contains extended data, the metadata payload structure will contain only its type URL. To retrieve the full extended data, call this method.
Returns the complete representation of the context as an ObjectFullContext.
| Parameters | |
|---|---|
| Name | Description |
request |
google::storage::control::v2::ViewObjectFullContextRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::storage::control::v2::ObjectFullContext > |
the result of the RPC. The response message type (google.storage.control.v2.ObjectFullContext) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |