Dataplex API - Module Google::Cloud::Dataplex (v0.3.0)

Reference documentation and code samples for the Dataplex API module Google::Cloud::Dataplex.

Methods

.configure

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

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

.content_service

def self.content_service(version: :v1, &block) -> ContentService::Client

Create a new client object for ContentService.

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

About ContentService

ContentService manages Notebook and SQL Scripts for Dataplex.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (ContentService::Client) — A client object for the specified version.

.dataplex_service

def self.dataplex_service(version: :v1, &block) -> DataplexService::Client

Create a new client object for DataplexService.

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

About DataplexService

Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data adminstrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (DataplexService::Client) — A client object for the specified version.

.metadata_service

def self.metadata_service(version: :v1, &block) -> MetadataService::Client

Create a new client object for MetadataService.

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

About MetadataService

Metadata service manages metadata resources such as tables, filesets and partitions.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (MetadataService::Client) — A client object for the specified version.

Constants

VERSION

value: "0.3.0"