Package google.cloud.datacatalog.lineage.configmanagement.v1

Index

• ConfigManagementService (interface)
• Config (message)
• Config.Ingestion (message)
• Config.Ingestion.IngestionRule (message)
• Config.Ingestion.IngestionRule.IntegrationSelector (message)
• Config.Ingestion.IngestionRule.IntegrationSelector.Integration (enum)
• Config.Ingestion.IngestionRule.LineageEnablement (message)
• GetConfigRequest (message)
• UpdateConfigRequest (message)

ConfigManagementService

Lineage Config Management service. Config Management service is used to manage the configuration for Data Lineage. These Configs define different configuration options for Lineage customers to control behaviour of lineage systems.

GetConfig
rpc GetConfig(GetConfigRequest) returns (Config) Get the Config for a given resource. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: datalineage.configs.get For more information, see the IAM documentation.

UpdateConfig

rpc UpdateConfig(UpdateConfigRequest) returns (Config) Update the Config for a given resource. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: datalineage.configs.update For more information, see the IAM documentation.

Config

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

Fields
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	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.

Ingestion

Defines how Lineage should be ingested for a given resource.

Fields
rules[]	IngestionRule Optional. List of rules for Data Lineage ingestion.

IngestionRule

Ingestion rule for Data Lineage ingestion.

Fields
integration_selector	IntegrationSelector Required. Integration selector of the rule. The rule is only applied to the Integration selected by the selector.
lineage_enablement	LineageEnablement Required. Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children. If unspecified, the ingestion will be enabled only if it was configured in the resource's parent.

IntegrationSelector

Integration selector of the rule. The rule is only applied to the Integration selected by the selector.

Fields
integration	Integration Required. Integration to which the rule applies. This field can be used to specify the integration against which the ingestion rule should be applied.

Integration

Integration to which the rule applies. This enum is expected to grow over time.

Enums
INTEGRATION_UNSPECIFIED	Integration is Unspecified
DATAPROC	Dataproc

LineageEnablement

Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children.

Fields
enabled	bool Optional. If true, ingestion of lineage should be enabled. If false, it should be disabled. If unspecified, the system default value is used.

GetConfigRequest

Request message for GetConfig RPC.

Fields
name	string Required. REQUIRED: The resource name of the config to be fetched. 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

UpdateConfigRequest

Request message for UpdateConfig RPC.

Fields
config	Config Required. REQUIRED: The config to be applied to the resource and all its descendants.