Storage Control V2 API - Class Google::Cloud::Storage::Control::V2::StorageControl::Rest::Client (v1.5.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

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

#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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#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