Data Lineage V1 API - Class Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::Client (v0.1.0)

Reference documentation and code samples for the Data Lineage V1 API class Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::Client.

Client for the ConfigManagementService service.

Lineage Config Management service. Config Management service is used to manage the configuration for Data Lineage. These Configs define different configuration options for Lineage customers to control behaviour of lineage systems.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the ConfigManagementService 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 ConfigManagementService clients
::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the ConfigManagementService 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_config

def get_config(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config
def get_config(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config

Get the Config for a given resource.

Overloads 
def get_config(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config
Pass arguments to get_config via a request object, either of type GetConfigRequest or an equivalent Hash.
Parameters 
def get_config(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config
Pass arguments to get_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. REQUIRED: The resource name of the config to be fetched. Format: organizations/{organization_id}/locations/global/config folders/{folder_id}/locations/global/config projects/{project_id}/locations/global/config projects/{project_number}/locations/global/config
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/data_catalog/lineage/config_management/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::GetConfigRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config.
p result

#initialize

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

Create a new ConfigManagementService client object.

Yields
  • (config) — Configure the ConfigManagementService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::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_config

def update_config(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config
def update_config(config: nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config

Update the Config for a given resource.

Overloads 
def update_config(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config
Pass arguments to update_config via a request object, either of type UpdateConfigRequest or an equivalent Hash.
Parameters 
def update_config(config: nil) -> ::Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config
Pass arguments to update_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
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/data_catalog/lineage/config_management/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::ConfigManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::UpdateConfigRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::Lineage::ConfigManagement::V1::Config.
p result