Google Cloud Dataform V1beta1 Client - Class InvocationConfig (0.19.0)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class InvocationConfig.

Includes various configuration options for a workflow invocation.

If both included_targets and included_tags are unset, all actions will be included.

Generated from protobuf message google.cloud.dataform.v1beta1.InvocationConfig

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ included_targets array<Target>

Optional. The set of action identifiers to include.

↳ included_tags string[]

Optional. The set of tags to include.

↳ transitive_dependencies_included bool

Optional. When set to true, transitive dependencies of included actions will be executed.

↳ transitive_dependents_included bool

Optional. When set to true, transitive dependents of included actions will be executed.

↳ fully_refresh_incremental_tables_enabled bool

Optional. When set to true, any incremental tables will be fully refreshed.

↳ service_account string

Optional. The service account to run workflow invocations under.

↳ end_user_auth_config InvocationConfig\EndUserAuthenticationConfig

Optional. Configuration for end user authentication. Do not set if service_account is used.

↳ query_priority int

Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud-0google-0com.linkedin.net.nz/bigquery/docs/running-queries#queries.

↳ concurrent_actions_limit int

Optional. Maximum number of actions that can be executed concurrently.

↳ execution_mode int

Optional. Specifies the execution mode for the workflow invocation.

getIncludedTargets

Optional. The set of action identifiers to include.

Returns
Type Description
Google\Protobuf\RepeatedField<Target>

setIncludedTargets

Optional. The set of action identifiers to include.

Parameter
Name Description
var array<Target>
Returns
Type Description
$this

getIncludedTags

Optional. The set of tags to include.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setIncludedTags

Optional. The set of tags to include.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getTransitiveDependenciesIncluded

Optional. When set to true, transitive dependencies of included actions will be executed.

Returns
Type Description
bool

setTransitiveDependenciesIncluded

Optional. When set to true, transitive dependencies of included actions will be executed.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTransitiveDependentsIncluded

Optional. When set to true, transitive dependents of included actions will be executed.

Returns
Type Description
bool

setTransitiveDependentsIncluded

Optional. When set to true, transitive dependents of included actions will be executed.

Parameter
Name Description
var bool
Returns
Type Description
$this

getFullyRefreshIncrementalTablesEnabled

Optional. When set to true, any incremental tables will be fully refreshed.

Returns
Type Description
bool

setFullyRefreshIncrementalTablesEnabled

Optional. When set to true, any incremental tables will be fully refreshed.

Parameter
Name Description
var bool
Returns
Type Description
$this

getServiceAccount

Optional. The service account to run workflow invocations under.

Returns
Type Description
string

setServiceAccount

Optional. The service account to run workflow invocations under.

Parameter
Name Description
var string
Returns
Type Description
$this

getEndUserAuthConfig

Optional. Configuration for end user authentication.

Do not set if service_account is used.

Returns
Type Description
InvocationConfig\EndUserAuthenticationConfig|null

hasEndUserAuthConfig

clearEndUserAuthConfig

setEndUserAuthConfig

Optional. Configuration for end user authentication.

Do not set if service_account is used.

Parameter
Name Description
var InvocationConfig\EndUserAuthenticationConfig
Returns
Type Description
$this

getQueryPriority

Optional. Specifies the priority for query execution in BigQuery.

More information can be found at https://cloud-0google-0com.linkedin.net.nz/bigquery/docs/running-queries#queries.

Returns
Type Description
int

hasQueryPriority

clearQueryPriority

setQueryPriority

Optional. Specifies the priority for query execution in BigQuery.

More information can be found at https://cloud-0google-0com.linkedin.net.nz/bigquery/docs/running-queries#queries.

Parameter
Name Description
var int
Returns
Type Description
$this

getConcurrentActionsLimit

Optional. Maximum number of actions that can be executed concurrently.

Returns
Type Description
int

hasConcurrentActionsLimit

clearConcurrentActionsLimit

setConcurrentActionsLimit

Optional. Maximum number of actions that can be executed concurrently.

Parameter
Name Description
var int
Returns
Type Description
$this

getExecutionMode

Optional. Specifies the execution mode for the workflow invocation.

Returns
Type Description
int Enum of type ExecutionMode.

setExecutionMode

Optional. Specifies the execution mode for the workflow invocation.

Parameter
Name Description
var int

Enum of type ExecutionMode.

Returns
Type Description
$this