Google Cloud Run V2 Client - Class ExecutionTemplate (0.4.0)

Reference documentation and code samples for the Google Cloud Run V2 Client class ExecutionTemplate.

ExecutionTemplate describes the data an execution should have when created from a template.

Generated from protobuf message google.cloud.run.v2.ExecutionTemplate

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
`↳ parallelism`	`int` Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.
`↳ task_count`	`int` Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.
`↳ template`	`Google\Cloud\Run\V2\TaskTemplate` Required. Describes the task(s) that will be created when executing an execution.

getLabels

Unstructured key value map that can be used to organize and categorize objects.

User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

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

setLabels

Unstructured key value map that can be used to organize and categorize objects.

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

Returns
Type	Description
`$this`

getAnnotations

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

This field follows Kubernetes annotations' namespacing, limits, and rules.

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

setAnnotations

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

This field follows Kubernetes annotations' namespacing, limits, and rules.

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

Returns
Type	Description
`$this`

getParallelism

Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count.

When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.

Returns
Type	Description
`int`

setParallelism

Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTaskCount

Specifies the desired number of tasks the execution should run.

Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.

Returns
Type	Description
`int`

setTaskCount

Specifies the desired number of tasks the execution should run.

Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTemplate

Required. Describes the task(s) that will be created when executing an execution.

Returns
Type	Description
`Google\Cloud\Run\V2\TaskTemplate\|null`

hasTemplate

clearTemplate

setTemplate

Required. Describes the task(s) that will be created when executing an execution.

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\TaskTemplate`

Returns
Type	Description
`$this`