Data Lineage API - Module Google::Cloud::DataCatalog::Lineage (v1.1.2)

Reference documentation and code samples for the Data Lineage API module Google::Cloud::DataCatalog::Lineage.

Methods

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-data_catalog-lineage 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
  • (::Google::Cloud.configure.data_catalog_lineage)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.lineage

def self.lineage(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Lineage.

By default, this returns an instance of Google::Cloud::DataCatalog::Lineage::V1::Lineage::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 Lineage 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 Lineage service. You can determine whether the method will succeed by calling Lineage.lineage_available?.

About Lineage

Lineage is used to track data flows between assets over time. You can create LineageEvents to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables.

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.

.lineage_available?

def self.lineage_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the Lineage service is supported by the current client. If true, you can retrieve a client object by calling Lineage.lineage. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Lineage service, or if the versioned client gem needs an update to support the Lineage service.

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
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.1.2"