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
KRM-style labels for the resource. Cloud Run API v2 does not support labels with |
↳ annotations |
array|Google\Protobuf\Internal\MapField
KRM-style annotations for the resource. Cloud Run API v2 does not support annotations with |
↳ 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. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
↳ template |
Google\Cloud\Run\V2\TaskTemplate
Required. Describes the task(s) that will be created when executing an execution. |
getLabels
KRM-style labels for the resource.
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
KRM-style labels for the resource.
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotations
KRM-style annotations for the resource.
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
KRM-style annotations for the resource.
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.
| 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.
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.
| 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. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
| 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. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
| 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 | |