Google Cloud Deploy V1 Client - Class ExecutionConfig (0.4.1)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class ExecutionConfig.

Configuration of the environment to use when calling Skaffold.

Generated from protobuf message google.cloud.deploy.v1.ExecutionConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ usages array

Required. Usages when this configuration should be applied.

↳ default_pool Google\Cloud\Deploy\V1\DefaultPool

Optional. Use default Cloud Build pool.

↳ private_pool Google\Cloud\Deploy\V1\PrivatePool

Optional. Use private Cloud Build pool.

↳ worker_pool string

Optional. The resource name of the WorkerPool, with the format projects/{project}/locations/{location}/workerPools/{worker_pool}. If this optional field is unspecified, the default Cloud Build pool will be used.

↳ service_account string

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

↳ artifact_storage string

Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.

↳ execution_timeout Google\Protobuf\Duration

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

getUsages

Required. Usages when this configuration should be applied.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setUsages

Required. Usages when this configuration should be applied.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getDefaultPool

Optional. Use default Cloud Build pool.

Returns
TypeDescription
Google\Cloud\Deploy\V1\DefaultPool|null

hasDefaultPool

setDefaultPool

Optional. Use default Cloud Build pool.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\DefaultPool
Returns
TypeDescription
$this

getPrivatePool

Optional. Use private Cloud Build pool.

Returns
TypeDescription
Google\Cloud\Deploy\V1\PrivatePool|null

hasPrivatePool

setPrivatePool

Optional. Use private Cloud Build pool.

Parameter
NameDescription
var Google\Cloud\Deploy\V1\PrivatePool
Returns
TypeDescription
$this

getWorkerPool

Optional. The resource name of the WorkerPool, with the format projects/{project}/locations/{location}/workerPools/{worker_pool}.

If this optional field is unspecified, the default Cloud Build pool will be used.

Returns
TypeDescription
string

setWorkerPool

Optional. The resource name of the WorkerPool, with the format projects/{project}/locations/{location}/workerPools/{worker_pool}.

If this optional field is unspecified, the default Cloud Build pool will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceAccount

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

Returns
TypeDescription
string

setServiceAccount

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getArtifactStorage

Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir").

If unspecified, a default bucket located in the same region will be used.

Returns
TypeDescription
string

setArtifactStorage

Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir").

If unspecified, a default bucket located in the same region will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExecutionTimeout

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasExecutionTimeout

clearExecutionTimeout

setExecutionTimeout

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getExecutionEnvironment

Returns
TypeDescription
string