Reference documentation and code samples for the Data Catalog API module Google::Cloud::DataCatalog.
Methods
.configure
def self.configure() -> ::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.
- (::Google::Cloud.configure.data_catalog)
- (::Google::Cloud::Config) — The default configuration used by this library
.data_catalog
def self.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.
Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataCatalog service. You can determine whether the method will succeed by calling DataCatalog.data_catalog_available?.
About DataCatalog
Data Catalog API service allows you to discover, understand, and manage your data.
-
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
.
- (::Object) — A client object for the specified version.
.data_catalog_available?
def self.data_catalog_available?(version: :v1, transport: :grpc) -> boolean
Determines whether the DataCatalog service is supported by the current client. If true, you can retrieve a client object by calling DataCatalog.data_catalog. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataCatalog service, or if the versioned client gem needs an update to support the DataCatalog service.
-
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
.
- (boolean) — Whether the service is available.
.policy_tag_manager
def self.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.
Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the PolicyTagManager service. You can determine whether the method will succeed by calling DataCatalog.policy_tag_manager_available?.
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.
-
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
.
- (::Object) — A client object for the specified version.
.policy_tag_manager_available?
def self.policy_tag_manager_available?(version: :v1, transport: :grpc) -> boolean
Determines whether the PolicyTagManager service is supported by the current client. If true, you can retrieve a client object by calling DataCatalog.policy_tag_manager. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the PolicyTagManager service, or if the versioned client gem needs an update to support the PolicyTagManager service.
-
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
.
- (boolean) — Whether the service is available.
.policy_tag_manager_serialization
def self.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.
Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the PolicyTagManagerSerialization service. You can determine whether the method will succeed by calling DataCatalog.policy_tag_manager_serialization_available?.
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.
-
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
.
- (::Object) — A client object for the specified version.
.policy_tag_manager_serialization_available?
def self.policy_tag_manager_serialization_available?(version: :v1, transport: :grpc) -> boolean
Determines whether the PolicyTagManagerSerialization service is supported by the current client. If true, you can retrieve a client object by calling DataCatalog.policy_tag_manager_serialization. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the PolicyTagManagerSerialization service, or if the versioned client gem needs an update to support the PolicyTagManagerSerialization service.
-
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
.
- (boolean) — Whether the service is available.
Constants
VERSION
value: "1.7.0"