Google Cloud Data Catalog Lineage V1 Client - Class Config (1.3.0)

Reference documentation and code samples for the Google Cloud Data Catalog Lineage V1 Client class Config.

Configuration for Data Lineage. Defines different configuration options for Lineage customers to control behaviour of lineage systems.

Generated from protobuf message google.cloud.datacatalog.lineage.configmanagement.v1.Config

Namespace

Google \ Cloud \ DataCatalog \ Lineage \ ConfigManagement \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the config. 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

↳ ingestion Config\Ingestion

Optional. Ingestion rule for Data Lineage ingestion.

↳ etag string

Optional. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a config from overwriting each other. It is required that systems make use of the etag in the read-modify-write cycle to perform config updates in order to avoid race conditions: An etag is returned in the response to GetConfig, and systems are expected to put that etag in the request to UpdateConfig to ensure that their change will be applied to the same version of the config. If an etag is not provided in the call to UpdateConfig, then the existing config, if any, will be overwritten.

getName

Identifier. The resource name of the config.

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

Returns
Type Description
string

setName

Identifier. The resource name of the config.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getIngestion

Optional. Ingestion rule for Data Lineage ingestion.

Returns
Type Description
Config\Ingestion|null

hasIngestion

clearIngestion

setIngestion

Optional. Ingestion rule for Data Lineage ingestion.

Parameter
Name Description
var Config\Ingestion
Returns
Type Description
$this

getEtag

Optional. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a config from overwriting each other. It is required that systems make use of the etag in the read-modify-write cycle to perform config updates in order to avoid race conditions: An etag is returned in the response to GetConfig, and systems are expected to put that etag in the request to UpdateConfig to ensure that their change will be applied to the same version of the config.

If an etag is not provided in the call to UpdateConfig, then the existing config, if any, will be overwritten.

Returns
Type Description
string

setEtag

Optional. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a config from overwriting each other. It is required that systems make use of the etag in the read-modify-write cycle to perform config updates in order to avoid race conditions: An etag is returned in the response to GetConfig, and systems are expected to put that etag in the request to UpdateConfig to ensure that their change will be applied to the same version of the config.

If an etag is not provided in the call to UpdateConfig, then the existing config, if any, will be overwritten.

Parameter
Name Description
var string
Returns
Type Description
$this