Storage Control V2 API - Class Google::Cloud::Storage::Control::V2::StorageControl::Client (v0.1.0)

Reference documentation and code samples for the Storage Control V2 API class Google::Cloud::Storage::Control::V2::StorageControl::Client.

Client for the StorageControl service.

StorageControl service includes selected control plane operations.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the StorageControl Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all StorageControl clients
::Google::Cloud::Storage::Control::V2::StorageControl::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the StorageControl Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_folder

def create_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::Folder
def create_folder(parent: nil, folder: nil, folder_id: nil, recursive: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::Folder

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Overloads 
def create_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::Folder
Pass arguments to create_folder via a request object, either of type CreateFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::CreateFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_folder(parent: nil, folder: nil, folder_id: nil, recursive: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::Folder
Pass arguments to create_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
  • folder (::Google::Cloud::Storage::Control::V2::Folder, ::Hash) — 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 (::String) — 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.
  • recursive (::Boolean) — Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::CreateFolderRequest.new

# Call the create_folder method.
result = client.create_folder request

# The returned object is of type Google::Cloud::Storage::Control::V2::Folder.
p result

#create_managed_folder

def create_managed_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder
def create_managed_folder(parent: nil, managed_folder: nil, managed_folder_id: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder

Creates a new managed folder.

Overloads 
def create_managed_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder
Pass arguments to create_managed_folder via a request object, either of type CreateManagedFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::CreateManagedFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_managed_folder(parent: nil, managed_folder: nil, managed_folder_id: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder
Pass arguments to create_managed_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Name of the bucket this managed folder belongs to.
  • managed_folder (::Google::Cloud::Storage::Control::V2::ManagedFolder, ::Hash) — 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 (::String) — Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::CreateManagedFolderRequest.new

# Call the create_managed_folder method.
result = client.create_managed_folder request

# The returned object is of type Google::Cloud::Storage::Control::V2::ManagedFolder.
p result

#delete_folder

def delete_folder(request, options = nil) -> ::Google::Protobuf::Empty
def delete_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Google::Protobuf::Empty

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Overloads 
def delete_folder(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_folder via a request object, either of type DeleteFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::DeleteFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}
  • if_metageneration_match (::Integer) — Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.
  • if_metageneration_not_match (::Integer) — Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::DeleteFolderRequest.new

# Call the delete_folder method.
result = client.delete_folder request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_managed_folder

def delete_managed_folder(request, options = nil) -> ::Google::Protobuf::Empty
def delete_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, allow_non_empty: nil, request_id: nil) -> ::Google::Protobuf::Empty

Permanently deletes an empty managed folder.

Overloads 
def delete_managed_folder(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_managed_folder via a request object, either of type DeleteManagedFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::DeleteManagedFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, allow_non_empty: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_managed_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
  • if_metageneration_match (::Integer) — The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.
  • if_metageneration_not_match (::Integer) — The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.
  • allow_non_empty (::Boolean) — Allows deletion of a managed folder even if it is not empty. A managed folder is empty if it manages no child managed folders or objects. Caller must have permission for storage.managedFolders.setIamPolicy.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::DeleteManagedFolderRequest.new

# Call the delete_managed_folder method.
result = client.delete_managed_folder request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_folder

def get_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::Folder
def get_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::Folder

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Overloads 
def get_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::Folder
Pass arguments to get_folder via a request object, either of type GetFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::GetFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::Folder
Pass arguments to get_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}
  • if_metageneration_match (::Integer) — Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.
  • if_metageneration_not_match (::Integer) — Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetFolderRequest.new

# Call the get_folder method.
result = client.get_folder request

# The returned object is of type Google::Cloud::Storage::Control::V2::Folder.
p result

#get_managed_folder

def get_managed_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder
def get_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder

Returns metadata for the specified managed folder.

Overloads 
def get_managed_folder(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder
Pass arguments to get_managed_folder via a request object, either of type GetManagedFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::GetManagedFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::ManagedFolder
Pass arguments to get_managed_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}
  • if_metageneration_match (::Integer) — The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.
  • if_metageneration_not_match (::Integer) — The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetManagedFolderRequest.new

# Call the get_managed_folder method.
result = client.get_managed_folder request

# The returned object is of type Google::Cloud::Storage::Control::V2::ManagedFolder.
p result

#get_storage_layout

def get_storage_layout(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::StorageLayout
def get_storage_layout(name: nil, prefix: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::StorageLayout

Returns the storage layout configuration for a given bucket.

Overloads 
def get_storage_layout(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::StorageLayout
Pass arguments to get_storage_layout via a request object, either of type GetStorageLayoutRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_storage_layout(name: nil, prefix: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::StorageLayout
Pass arguments to get_storage_layout via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout
  • prefix (::String) — An optional prefix used for permission check. It is useful when the caller only has limited permissions under a specific prefix.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest.new

# Call the get_storage_layout method.
result = client.get_storage_layout request

# The returned object is of type Google::Cloud::Storage::Control::V2::StorageLayout.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new StorageControl client object.

Yields
  • (config) — Configure the StorageControl client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new do |config|
  config.timeout = 10.0
end

#list_folders

def list_folders(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>
def list_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, delimiter: nil, lexicographic_start: nil, lexicographic_end: nil, request_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Overloads 
def list_folders(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>
Pass arguments to list_folders via a request object, either of type ListFoldersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::ListFoldersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, delimiter: nil, lexicographic_start: nil, lexicographic_end: nil, request_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>
Pass arguments to list_folders via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
  • page_size (::Integer) — Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
  • page_token (::String) — Optional. A previously-returned page token representing part of the larger set of results to view.
  • prefix (::String) — Optional. Filter results to folders whose names begin with this prefix. If set, the value must either be an empty string or end with a '/'.
  • delimiter (::String) — Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
  • lexicographic_start (::String) — Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
  • lexicographic_end (::String) — Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListFoldersRequest.new

# Call the list_folders method.
result = client.list_folders request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Storage::Control::V2::Folder.
  p item
end

#list_managed_folders

def list_managed_folders(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>
def list_managed_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, request_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>

Retrieves a list of managed folders for a given bucket.

Overloads 
def list_managed_folders(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>
Pass arguments to list_managed_folders via a request object, either of type ListManagedFoldersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::ListManagedFoldersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_managed_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, request_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>
Pass arguments to list_managed_folders via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Name of the bucket this managed folder belongs to.
  • page_size (::Integer) — Optional. Maximum number of managed folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
  • page_token (::String) — Optional. A previously-returned page token representing part of the larger set of results to view.
  • prefix (::String) — Optional. Filter results to match managed folders with name starting with this prefix.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListManagedFoldersRequest.new

# Call the list_managed_folders method.
result = client.list_managed_folders request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Storage::Control::V2::ManagedFolder.
  p item
end

#operations_client

def operations_client() -> ::Google::Cloud::Storage::Control::V2::StorageControl::Operations

Get the associated client for long-running operations.

Returns

#rename_folder

def rename_folder(request, options = nil) -> ::Gapic::Operation
def rename_folder(name: nil, destination_folder_id: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Gapic::Operation

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. Hierarchical namespace buckets are in allowlist preview.

Overloads 
def rename_folder(request, options = nil) -> ::Gapic::Operation
Pass arguments to rename_folder via a request object, either of type RenameFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::RenameFolderRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def rename_folder(name: nil, destination_folder_id: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to rename_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}
  • destination_folder_id (::String) — Required. The destination folder ID, e.g. foo/bar/.
  • if_metageneration_match (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration matches the given value.
  • if_metageneration_not_match (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration does not match the given value.
  • request_id (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::RenameFolderRequest.new

# Call the rename_folder method.
result = client.rename_folder request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)