Google Cloud Run V2 Client - Class SubmitBuildRequest (1.5.0)

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

Request message for submitting a Build.

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

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: projects/{project}/locations/{location}

↳ storage_source StorageSource

Required. Source for the build.

↳ image_uri string

Required. Artifact Registry URI to store the built image.

↳ buildpack_build SubmitBuildRequest\BuildpacksBuild

Build the source using Buildpacks.

↳ docker_build SubmitBuildRequest\DockerBuild

Build the source using Docker. This means the source has a Dockerfile.

↳ service_account string

Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.

↳ worker_pool string

Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

↳ tags array

Optional. Additional tags to annotate the build.

getParent

Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used.

Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used.

Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getStorageSource

Required. Source for the build.

Returns
Type Description
StorageSource|null

hasStorageSource

setStorageSource

Required. Source for the build.

Parameter
Name Description
var StorageSource
Returns
Type Description
$this

getImageUri

Required. Artifact Registry URI to store the built image.

Returns
Type Description
string

setImageUri

Required. Artifact Registry URI to store the built image.

Parameter
Name Description
var string
Returns
Type Description
$this

getBuildpackBuild

Build the source using Buildpacks.

Returns
Type Description
SubmitBuildRequest\BuildpacksBuild|null

hasBuildpackBuild

setBuildpackBuild

Build the source using Buildpacks.

Parameter
Name Description
var SubmitBuildRequest\BuildpacksBuild
Returns
Type Description
$this

getDockerBuild

Build the source using Docker. This means the source has a Dockerfile.

Returns
Type Description
SubmitBuildRequest\DockerBuild|null

hasDockerBuild

setDockerBuild

Build the source using Docker. This means the source has a Dockerfile.

Parameter
Name Description
var SubmitBuildRequest\DockerBuild
Returns
Type Description
$this

getServiceAccount

Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.

Returns
Type Description
string

setServiceAccount

Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkerPool

Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

Returns
Type Description
string

setWorkerPool

Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

Parameter
Name Description
var string
Returns
Type Description
$this

getTags

Optional. Additional tags to annotate the build.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTags

Optional. Additional tags to annotate the build.

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

getSource

Returns
Type Description
string

getBuildType

Returns
Type Description
string