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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of the bucket in which the folder will reside. |
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.
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.
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.
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.
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.
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 for a given bucket.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of the bucket in which to look for folders. |
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 for a given 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.
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(google::storage::control::v2::RenameFolderRequest const &, Options)
Renames a source folder to a destination folder.
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 |
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 |