Module: Google::Cloud::DataCatalog

Defined in:
lib/google/cloud/data_catalog.rb,
lib/google/cloud/data_catalog/version.rb

Constant Summary collapse

VERSION = 
"1.6.1"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.data_catalog| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-data_catalog library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



187
188
189
190
191
 
# File 'lib/google/cloud/data_catalog.rb', line 187

def self.configure
  yield ::Google::Cloud.configure.data_catalog if block_given?

  ::Google::Cloud.configure.data_catalog
end

.data_catalog(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DataCatalog.

By default, this returns an instance of Google::Cloud::DataCatalog::V1::DataCatalog::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataCatalog service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About DataCatalog

Data Catalog API service allows you to discover, understand, and manage your data.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/data_catalog.rb', line 71

def self.data_catalog version: :v1, transport: :grpc, &block
  require "google/cloud/data_catalog/#{version.to_s.downcase}"

  package_name = Google::Cloud::DataCatalog
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DataCatalog.const_get(package_name).const_get(:DataCatalog)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.policy_tag_manager(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for PolicyTagManager.

By default, this returns an instance of Google::Cloud::DataCatalog::V1::PolicyTagManager::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the PolicyTagManager service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About PolicyTagManager

Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/cloud/data_catalog.rb', line 110

def self.policy_tag_manager version: :v1, transport: :grpc, &block
  require "google/cloud/data_catalog/#{version.to_s.downcase}"

  package_name = Google::Cloud::DataCatalog
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DataCatalog.const_get(package_name).const_get(:PolicyTagManager)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.policy_tag_manager_serialization(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for PolicyTagManagerSerialization.

By default, this returns an instance of Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the PolicyTagManagerSerialization service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About PolicyTagManagerSerialization

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/google/cloud/data_catalog.rb', line 147

def self.policy_tag_manager_serialization version: :v1, transport: :grpc, &block
  require "google/cloud/data_catalog/#{version.to_s.downcase}"

  package_name = Google::Cloud::DataCatalog
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DataCatalog.const_get(package_name).const_get(:PolicyTagManagerSerialization)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end