Storage Control V2 API - Class Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client (v1.13.0)

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

REST 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::Rest::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.

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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::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

#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.

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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::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_folder_recursive

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

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

Overloads 
def delete_folder_recursive(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_folder_recursive via a request object, either of type DeleteFolderRecursiveRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest, ::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_recursive(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_folder_recursive 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 being deleted, however all of its contents will be deleted too. Format: projects/{project}/buckets/{bucket}/folders/{folder}
  • if_metageneration_match (::Integer) — Optional. Makes the operation only succeed conditional on whether the root folder's current metageneration matches the given value.
  • if_metageneration_not_match (::Integer) — Optional. Makes the operation only succeed conditional on whether the root 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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

# Call the delete_folder_recursive method.
result = client.delete_folder_recursive 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

#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.

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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::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_folder_intelligence_config

def get_folder_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
def get_folder_intelligence_config(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Returns the Folder scoped singleton IntelligenceConfig resource.

Overloads 
def get_folder_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to get_folder_intelligence_config via a request object, either of type GetFolderIntelligenceConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::GetFolderIntelligenceConfigRequest, ::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_intelligence_config(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to get_folder_intelligence_config 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).
Parameter
  • name (::String) — Required. The name of the IntelligenceConfig resource associated with your folder.

    Format: folders/{id}/locations/global/intelligenceConfig

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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

#get_intelligence_finding

def get_intelligence_finding(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFinding
def get_intelligence_finding(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFinding

Gets the IntelligenceFinding for a project.

Overloads 
def get_intelligence_finding(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFinding
Pass arguments to get_intelligence_finding via a request object, either of type GetIntelligenceFindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRequest, ::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_intelligence_finding(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFinding
Pass arguments to get_intelligence_finding 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).
Parameter
  • name (::String) — Required. The name of the IntelligenceFinding resource.

    Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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

#get_intelligence_finding_revision

def get_intelligence_finding_revision(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision
def get_intelligence_finding_revision(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision

Gets the IntelligenceFindingRevision resource.

Overloads 
def get_intelligence_finding_revision(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision
Pass arguments to get_intelligence_finding_revision via a request object, either of type GetIntelligenceFindingRevisionRequest or an equivalent Hash.
Parameters 
def get_intelligence_finding_revision(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision
Pass arguments to get_intelligence_finding_revision 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).
Parameter
  • name (::String) — Required. The name of the IntelligenceFindingRevision resource.

    Format:

    projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}/revisions/{revision}

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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

#get_organization_intelligence_config

def get_organization_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
def get_organization_intelligence_config(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Returns the Organization scoped singleton IntelligenceConfig resource.

Overloads 
def get_organization_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to get_organization_intelligence_config via a request object, either of type GetOrganizationIntelligenceConfigRequest or an equivalent Hash.
Parameters 
def get_organization_intelligence_config(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to get_organization_intelligence_config 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).
Parameter
  • name (::String) — Required. The name of the IntelligenceConfig resource associated with your organization.

    Format: organizations/{org_id}/locations/global/intelligenceConfig

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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

#get_project_intelligence_config

def get_project_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
def get_project_intelligence_config(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Returns the Project scoped singleton IntelligenceConfig resource.

Overloads 
def get_project_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to get_project_intelligence_config via a request object, either of type GetProjectIntelligenceConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::GetProjectIntelligenceConfigRequest, ::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_project_intelligence_config(name: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to get_project_intelligence_config 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).
Parameter
  • name (::String) — Required. The name of the IntelligenceConfig resource associated with your project.

    Format: projects/{id}/locations/global/intelligenceConfig

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::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 REST 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::Rest::Client.new

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

#list_folders

def list_folders(request, options = nil) -> ::Gapic::Rest::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::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>

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

Overloads 
def list_folders(request, options = nil) -> ::Gapic::Rest::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::Rest::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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::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_intelligence_finding_revisions

def list_intelligence_finding_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>
def list_intelligence_finding_revisions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>

Lists all the revisions of an IntelligenceFinding resource.

Overloads 
def list_intelligence_finding_revisions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>
Pass arguments to list_intelligence_finding_revisions via a request object, either of type ListIntelligenceFindingRevisionsRequest or an equivalent Hash.
Parameters 
def list_intelligence_finding_revisions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>
Pass arguments to list_intelligence_finding_revisions 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. The parent of the IntelligenceFindingRevision resource.

    Format:

    projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

  • page_size (::Integer) — Optional. The maximum number of IntelligenceFindingRevision resources to return.

    The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

  • page_token (::String) — Optional. A page token, received from a previous ListIntelligenceFindingRevisions call. Provide this to retrieve the subsequent page.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

# Call the list_intelligence_finding_revisions method.
result = client.list_intelligence_finding_revisions 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::IntelligenceFindingRevision.
  p item
end

#list_intelligence_findings

def list_intelligence_findings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>
def list_intelligence_findings(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>

Lists the IntelligenceFinding resources for the specified the project.

Overloads 
def list_intelligence_findings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>
Pass arguments to list_intelligence_findings via a request object, either of type ListIntelligenceFindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::ListIntelligenceFindingsRequest, ::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_intelligence_findings(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>
Pass arguments to list_intelligence_findings 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. The parent of the IntelligenceFinding resource.

    Format: projects/{project}/locations/{location}

  • filter (::String) — Optional. The filter expression to be applied. Supports filtering by type and associated_resources.
  • page_size (::Integer) — Optional. The maximum number of IntelligenceFinding resources to return.

    The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

  • page_token (::String) — Optional. A page token, received from a previous ListIntelligenceFindings call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListIntelligenceFindings must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

# Call the list_intelligence_findings method.
result = client.list_intelligence_findings 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::IntelligenceFinding.
  p item
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::Storage::Control::V2::StorageControl::Rest::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.

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
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::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

#summarize_intelligence_findings

def summarize_intelligence_findings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>
def summarize_intelligence_findings(parent: nil, resource_scope: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>

Summarizes the intelligence findings for the specified scope (organization, folder or project).

Overloads 
def summarize_intelligence_findings(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>
Pass arguments to summarize_intelligence_findings via a request object, either of type Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest, ::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 summarize_intelligence_findings(parent: nil, resource_scope: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>
Pass arguments to summarize_intelligence_findings 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. The scope to summarize the findings for. Format:

    • organizations/{organization}/locations/{location}
    • folders/{folder}/locations/{location}
    • projects/{project}/locations/{location}
  • resource_scope (::Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest::ResourceScope) — Optional. Determines the granularity of the findings when the parent is an organization or folder.

    • PARENT (or not set): A single summary is returned for each insight type, aggregated across the entire parent scope.
    • PROJECT: A separate summary is returned for each insight type for every project within the parent scope.

    The only supported values are PARENT and PROJECT. If no value is specified, the API behaviour defaults to the PARENT.

  • filter (::String) — Optional. The filter expression, following AIP-160. Supports filtering by FindingType.
  • page_size (::Integer) — Optional. The maximum number of findings to return.

    The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

  • page_token (::String) — Optional. A page token, received from a previous SummarizeIntelligenceFindings call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to SummarizeIntelligenceFindings must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

# Call the summarize_intelligence_findings method.
result = client.summarize_intelligence_findings 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::FindingSummary.
  p item
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_folder_intelligence_config

def update_folder_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
def update_folder_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Updates the Folder scoped singleton IntelligenceConfig resource.

Overloads 
def update_folder_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to update_folder_intelligence_config via a request object, either of type UpdateFolderIntelligenceConfigRequest or an equivalent Hash.
Parameters 
def update_folder_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to update_folder_intelligence_config 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
  • intelligence_config (::Google::Cloud::Storage::Control::V2::IntelligenceConfig, ::Hash) — Required. The IntelligenceConfig resource to be updated.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.
  • request_id (::String) — Optional. The ID that uniquely identifies the request, preventing duplicate processing.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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

#update_organization_intelligence_config

def update_organization_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
def update_organization_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Updates the Organization scoped singleton IntelligenceConfig resource.

Overloads 
def update_organization_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to update_organization_intelligence_config via a request object, either of type UpdateOrganizationIntelligenceConfigRequest or an equivalent Hash.
Parameters 
def update_organization_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to update_organization_intelligence_config 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
  • intelligence_config (::Google::Cloud::Storage::Control::V2::IntelligenceConfig, ::Hash) — Required. The IntelligenceConfig resource to be updated.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.
  • request_id (::String) — Optional. The ID that uniquely identifies the request, preventing duplicate processing.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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

#update_project_intelligence_config

def update_project_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
def update_project_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Updates the Project scoped singleton IntelligenceConfig resource.

Overloads 
def update_project_intelligence_config(request, options = nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to update_project_intelligence_config via a request object, either of type UpdateProjectIntelligenceConfigRequest or an equivalent Hash.
Parameters 
def update_project_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) -> ::Google::Cloud::Storage::Control::V2::IntelligenceConfig
Pass arguments to update_project_intelligence_config 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
  • intelligence_config (::Google::Cloud::Storage::Control::V2::IntelligenceConfig, ::Hash) — Required. The IntelligenceConfig resource to be updated.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.
  • request_id (::String) — Optional. The ID that uniquely identifies the request, preventing duplicate processing.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::Rest::Client.new

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

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

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