Google Cloud Data Catalog Lineage V1 Client - Class UpdateRunRequest (0.5.5)

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

Request message for UpdateRun.

Generated from protobuf message google.cloud.datacatalog.lineage.v1.UpdateRunRequest

Namespace

Google \ Cloud \ DataCatalog \ Lineage \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ run Google\Cloud\DataCatalog\Lineage\V1\Run

Required. The lineage run to update. The run's name field is used to identify the run to update. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

↳ update_mask Google\Protobuf\FieldMask

The list of fields to update. Currently not used. The whole message is updated.

↳ allow_missing bool

If set to true and the run is not found, the request creates it.

getRun

Required. The lineage run to update.

The run's name field is used to identify the run to update. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Returns
Type Description
Google\Cloud\DataCatalog\Lineage\V1\Run|null

hasRun

clearRun

setRun

Required. The lineage run to update.

The run's name field is used to identify the run to update. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Parameter
Name Description
var Google\Cloud\DataCatalog\Lineage\V1\Run
Returns
Type Description
$this

getUpdateMask

The list of fields to update. Currently not used. The whole message is updated.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

The list of fields to update. Currently not used. The whole message is updated.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getAllowMissing

If set to true and the run is not found, the request creates it.

Returns
Type Description
bool

setAllowMissing

If set to true and the run is not found, the request creates it.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
run Google\Cloud\DataCatalog\Lineage\V1\Run

Required. The lineage run to update.

The run's name field is used to identify the run to update.

Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

updateMask Google\Protobuf\FieldMask

The list of fields to update. Currently not used. The whole message is updated.

Returns
Type Description
Google\Cloud\DataCatalog\Lineage\V1\UpdateRunRequest