Google Cloud Run V2 Client - Class RunJobRequest (0.7.2)

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

Request message to create a new Execution of a Job.

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

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

↳ validate_only bool

Indicates that the request should be validated without actually deleting any resources.

↳ etag string

A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

↳ overrides Google\Cloud\Run\V2\RunJobRequest\Overrides

Overrides specification for a given execution of a job. If provided, overrides will be applied to update the execution or task spec.

getName

Required. The full name of the Job.

Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Returns
TypeDescription
string

setName

Required. The full name of the Job.

Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

Indicates that the request should be validated without actually deleting any resources.

Returns
TypeDescription
bool

setValidateOnly

Indicates that the request should be validated without actually deleting any resources.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEtag

A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Returns
TypeDescription
string

setEtag

A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOverrides

Overrides specification for a given execution of a job. If provided, overrides will be applied to update the execution or task spec.

Returns
TypeDescription
Google\Cloud\Run\V2\RunJobRequest\Overrides|null

hasOverrides

clearOverrides

setOverrides

Overrides specification for a given execution of a job. If provided, overrides will be applied to update the execution or task spec.

Parameter
NameDescription
var Google\Cloud\Run\V2\RunJobRequest\Overrides
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number. Please see Google\Cloud\Run\V2\JobsClient::jobName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Run\V2\RunJobRequest