Google Cloud Data Catalog Lineage V1 Client - Class Run (1.2.1)

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

A lineage run represents an execution of a process that creates lineage events.

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

Namespace

Google \ Cloud \ DataCatalog \ Lineage \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`
`↳ display_name`	`string` Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.`
`↳ attributes`	`array\|Google\Protobuf\Internal\MapField` Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
`↳ start_time`	`Google\Protobuf\Timestamp` Required. The timestamp of the start of the run.
`↳ end_time`	`Google\Protobuf\Timestamp` Optional. The timestamp of the end of the run.
`↳ state`	`int` Required. The state of the run.

getName

Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

Returns
Type	Description
`string`

setName

Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Optional. A human-readable name you can set to display in a user interface.

Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.

Returns
Type	Description
`string`

setDisplayName

Optional. A human-readable name you can set to display in a user interface.

Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAttributes

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAttributes

Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getStartTime

Required. The timestamp of the start of the run.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime