Google Cloud Run V2 Client - Class BuildpacksBuild (1.4.0)

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

Build the source using Buildpacks.

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

Namespace

Google \ Cloud \ Run \ V2 \ SubmitBuildRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ runtime string

The runtime name, e.g. 'go113'. Leave blank for generic builds.

↳ function_target string

Optional. Name of the function target if the source is a function source. Required for function builds.

↳ cache_image_uri string

Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.

↳ base_image string

Optional. The base image used to opt into automatic base image updates.

↳ environment_variables array|Google\Protobuf\Internal\MapField

Optional. User-provided build-time environment variables.

↳ enable_automatic_updates bool

Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.

getRuntime

The runtime name, e.g. 'go113'. Leave blank for generic builds.

Returns
Type Description
string

setRuntime

The runtime name, e.g. 'go113'. Leave blank for generic builds.

Parameter
Name Description
var string
Returns
Type Description
$this

getFunctionTarget

Optional. Name of the function target if the source is a function source.

Required for function builds.

Returns
Type Description
string

setFunctionTarget

Optional. Name of the function target if the source is a function source.

Required for function builds.

Parameter
Name Description
var string
Returns
Type Description
$this

getCacheImageUri

Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching.

This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.

Returns
Type Description
string

setCacheImageUri

Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching.

This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.

Parameter
Name Description
var string
Returns
Type Description
$this

getBaseImage

Optional. The base image used to opt into automatic base image updates.

Returns
Type Description
string

setBaseImage

Optional. The base image used to opt into automatic base image updates.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnvironmentVariables

Optional. User-provided build-time environment variables.

Returns
Type Description
Google\Protobuf\Internal\MapField

setEnvironmentVariables

Optional. User-provided build-time environment variables.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEnableAutomaticUpdates

Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.

Returns
Type Description
bool

setEnableAutomaticUpdates

Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.

Parameter
Name Description
var bool
Returns
Type Description
$this