Google Cloud BigQuery Migration V2 Client - Class MigrationWorkflow (1.1.0)

Reference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class MigrationWorkflow.

A migration workflow which specifies what needs to be done for an EDW migration.

Generated from protobuf message google.cloud.bigquery.migration.v2.MigrationWorkflow

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Immutable. Identifier. The unique identifier for the migration workflow. The ID is server-generated. Example: projects/123/locations/us/workflows/345

↳ display_name string

The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness.

↳ tasks array|Google\Protobuf\Internal\MapField

The tasks in a workflow in a named map. The name (i.e. key) has no meaning and is merely a convenient way to address a specific task in a workflow.

↳ state int

Output only. That status of the workflow.

↳ create_time Google\Protobuf\Timestamp

Time when the workflow was created.

↳ last_update_time Google\Protobuf\Timestamp

Time when the workflow was last updated.

getName

Output only. Immutable. Identifier. The unique identifier for the migration workflow. The ID is server-generated.

Example: projects/123/locations/us/workflows/345

Returns
Type Description
string

setName

Output only. Immutable. Identifier. The unique identifier for the migration workflow. The ID is server-generated.

Example: projects/123/locations/us/workflows/345

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness.

Returns
Type Description
string

setDisplayName

The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness.

Parameter
Name Description
var string
Returns
Type Description
$this

getTasks

The tasks in a workflow in a named map. The name (i.e. key) has no meaning and is merely a convenient way to address a specific task in a workflow.

Returns
Type Description
Google\Protobuf\Internal\MapField

setTasks

The tasks in a workflow in a named map. The name (i.e. key) has no meaning and is merely a convenient way to address a specific task in a workflow.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getState

Output only. That status of the workflow.

Returns
Type Description
int

setState

Output only. That status of the workflow.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

Time when the workflow was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Time when the workflow was created.

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

getLastUpdateTime

Time when the workflow was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastUpdateTime

clearLastUpdateTime

setLastUpdateTime

Time when the workflow was last updated.

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