Google Cloud Functions V1 Client - Class CloudFunction (1.6.5)

Reference documentation and code samples for the Google Cloud Functions V1 Client class CloudFunction.

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.

Generated from protobuf message google.cloud.functions.v1.CloudFunction

Namespace

Google \ Cloud \ Functions \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
↳ description string

User-provided description of a function.
↳ source_archive_url string

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
↳ source_repository Google\Cloud\Functions\V1\SourceRepository

Beta Feature The source repository where a function is hosted.
↳ source_upload_url string

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
↳ https_trigger Google\Cloud\Functions\V1\HttpsTrigger

An HTTPS endpoint type of source that can be triggered via URL.
↳ event_trigger Google\Cloud\Functions\V1\EventTrigger

A source that fires events in response to a condition in another service.
↳ status int

Output only. Status of the function deployment.
↳ entry_point string

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
↳ runtime string

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.
↳ timeout Google\Protobuf\Duration

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
↳ available_memory_mb int

The amount of memory in MB available for a function. Defaults to 256MB.
↳ service_account_email string

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.
↳ update_time Google\Protobuf\Timestamp

Output only. The last update timestamp of a Cloud Function.
↳ version_id int|string

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
↳ labels array|Google\Protobuf\Internal\MapField

Labels associated with this Cloud Function.
↳ environment_variables array|Google\Protobuf\Internal\MapField

Environment variables that shall be available during function execution.
↳ build_environment_variables array|Google\Protobuf\Internal\MapField

Build environment variables that shall be available during build time.
↳ network string

Deprecated: use vpc_connector
↳ max_instances int

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
↳ min_instances int

A lower bound for the number function instances that may coexist at a given time.
↳ vpc_connector string

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.
↳ vpc_connector_egress_settings int

The egress settings for the connector, controlling what traffic is diverted through it.
↳ ingress_settings int

The ingress settings for the function, controlling what traffic can reach it.
↳ kms_key_name string

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.
↳ build_worker_pool string

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. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
↳ build_id string

Output only. The Cloud Build ID of the latest successful deployment of the function.
↳ build_name string

Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.
↳ secret_environment_variables array<Google\Cloud\Functions\V1\SecretEnvVar>

Secret environment variables configuration.
↳ secret_volumes array<Google\Cloud\Functions\V1\SecretVolume>

Secret volumes configuration.
↳ source_token string

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
↳ docker_repository string

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.
↳ docker_registry int

Docker Registry to use for this deployment. If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.
↳ automatic_update_policy Google\Cloud\Functions\V1\CloudFunction\AutomaticUpdatePolicy

See the comment next to this message for more details.
↳ on_deploy_update_policy Google\Cloud\Functions\V1\CloudFunction\OnDeployUpdatePolicy

See the comment next to this message for more details.

getName

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

Returns
Type Description
string

setName

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

User-provided description of a function.

Returns
Type Description
string

setDescription

User-provided description of a function.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceArchiveUrl

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

Returns
Type Description
string

hasSourceArchiveUrl

setSourceArchiveUrl

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceRepository

Beta Feature The source repository where a function is hosted.

Returns
Type Description
Google\Cloud\Functions\V1\SourceRepository|null

hasSourceRepository

setSourceRepository

Beta Feature The source repository where a function is hosted.

Parameter
Name Description
var Google\Cloud\Functions\V1\SourceRepository
Returns
Type Description
$this

getSourceUploadUrl

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].

The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

Returns
Type Description
string

hasSourceUploadUrl

setSourceUploadUrl

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].

The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

Parameter
Name Description
var string
Returns
Type Description
$this

getHttpsTrigger

An HTTPS endpoint type of source that can be triggered via URL.

Returns
Type Description
Google\Cloud\Functions\V1\HttpsTrigger|null

hasHttpsTrigger

setHttpsTrigger

An HTTPS endpoint type of source that can be triggered via URL.

Parameter
Name Description
var Google\Cloud\Functions\V1\HttpsTrigger
Returns
Type Description
$this

getEventTrigger

A source that fires events in response to a condition in another service.

Returns
Type Description
Google\Cloud\Functions\V1\EventTrigger|null

hasEventTrigger

setEventTrigger

A source that fires events in response to a condition in another service.

Parameter
Name Description
var Google\Cloud\Functions\V1\EventTrigger
Returns
Type Description
$this

getStatus

Output only. Status of the function deployment.

Returns
Type Description
int

setStatus

Output only. Status of the function deployment.

Parameter
Name Description
var int
Returns
Type Description
$this

getEntryPoint

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.

Returns
Type Description
string

setEntryPoint

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.

Parameter
Name Description
var string
Returns
Type Description
$this

getRuntime

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

Returns
Type Description
string

setRuntime

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeout

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getAvailableMemoryMb

The amount of memory in MB available for a function.

Defaults to 256MB.

Returns
Type Description
int

setAvailableMemoryMb

The amount of memory in MB available for a function.

Defaults to 256MB.

Parameter
Name Description
var int
Returns
Type Description
$this

getServiceAccountEmail

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

Returns
Type Description
string

setServiceAccountEmail

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpdateTime

Output only. The last update timestamp of a Cloud Function.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last update timestamp of a Cloud Function.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getVersionId

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

Returns
Type Description
int|string

setVersionId

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getLabels

Labels associated with this Cloud Function.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels associated with this Cloud Function.

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

getEnvironmentVariables

Environment variables that shall be available during function execution.

Returns
Type Description
Google\Protobuf\Internal\MapField

setEnvironmentVariables

Environment variables that shall be available during function execution.

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

getBuildEnvironmentVariables

Build environment variables that shall be available during build time.

Returns
Type Description
Google\Protobuf\Internal\MapField

setBuildEnvironmentVariables

Build environment variables that shall be available during build time.

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

getNetwork

Deprecated: use vpc_connector

Returns
Type Description
string

setNetwork

Deprecated: use vpc_connector

Parameter
Name Description
var string
Returns
Type Description
$this

getMaxInstances

The limit on the maximum number of function instances that may coexist at a given time.

In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

Returns
Type Description
int

setMaxInstances

The limit on the maximum number of function instances that may coexist at a given time.

In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

Parameter
Name Description
var int
Returns
Type Description
$this

getMinInstances

A lower bound for the number function instances that may coexist at a given time.

Returns
Type Description
int

setMinInstances

A lower bound for the number function instances that may coexist at a given time.

Parameter
Name Description
var int
Returns
Type Description
$this

getVpcConnector

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it.

See the VPC documentation for more information on connecting Cloud projects.

Returns
Type Description
string

setVpcConnector

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it.

See the VPC documentation for more information on connecting Cloud projects.

Parameter
Name Description
var string
Returns
Type Description
$this

getVpcConnectorEgressSettings

The egress settings for the connector, controlling what traffic is diverted through it.

Returns
Type Description
int

setVpcConnectorEgressSettings

The egress settings for the connector, controlling what traffic is diverted through it.

Parameter
Name Description
var int
Returns
Type Description
$this

getIngressSettings

The ingress settings for the function, controlling what traffic can reach it.

Returns
Type Description
int

setIngressSettings

The ingress settings for the function, controlling what traffic can reach it.

Parameter
Name Description
var int
Returns
Type Description
$this

getKmsKeyName

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

  1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
  2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.
Returns
Type Description
string

setKmsKeyName

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

  1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
  2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.
Parameter
Name Description
var string
Returns
Type Description
$this

getBuildWorkerPool

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.

If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

Returns
Type Description
string

setBuildWorkerPool

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.

If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

Parameter
Name Description
var string
Returns
Type Description
$this

getBuildId

Output only. The Cloud Build ID of the latest successful deployment of the function.

Returns
Type Description
string

setBuildId

Output only. The Cloud Build ID of the latest successful deployment of the function.

Parameter
Name Description
var string
Returns
Type Description
$this

getBuildName

Output only. The Cloud Build Name of the function deployment.

projects/<project-number>/locations/<region>/builds/<build-id>.

Returns
Type Description
string

setBuildName

Output only. The Cloud Build Name of the function deployment.

projects/<project-number>/locations/<region>/builds/<build-id>.

Parameter
Name Description
var string
Returns
Type Description
$this

getSecretEnvironmentVariables

Secret environment variables configuration.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSecretEnvironmentVariables

Secret environment variables configuration.

Parameter
Name Description
var array<Google\Cloud\Functions\V1\SecretEnvVar>
Returns
Type Description
$this

getSecretVolumes

Secret volumes configuration.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSecretVolumes

Secret volumes configuration.

Parameter
Name Description
var array<Google\Cloud\Functions\V1\SecretVolume>
Returns
Type Description
$this

getSourceToken

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

Returns
Type Description
string

setSourceToken

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

Parameter
Name Description
var string
Returns
Type Description
$this

getDockerRepository

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build.

It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

Returns
Type Description
string

setDockerRepository

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build.

It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

Parameter
Name Description
var string
Returns
Type Description
$this

getDockerRegistry

Docker Registry to use for this deployment.

If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.

Returns
Type Description
int

setDockerRegistry

Docker Registry to use for this deployment.

If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.

Parameter
Name Description
var int
Returns
Type Description
$this

getAutomaticUpdatePolicy

See the comment next to this message for more details.

Returns
Type Description
Google\Cloud\Functions\V1\CloudFunction\AutomaticUpdatePolicy|null

hasAutomaticUpdatePolicy

setAutomaticUpdatePolicy

See the comment next to this message for more details.

Parameter
Name Description
var Google\Cloud\Functions\V1\CloudFunction\AutomaticUpdatePolicy
Returns
Type Description
$this

getOnDeployUpdatePolicy

See the comment next to this message for more details.

Returns
Type Description
Google\Cloud\Functions\V1\CloudFunction\OnDeployUpdatePolicy|null

hasOnDeployUpdatePolicy

setOnDeployUpdatePolicy

See the comment next to this message for more details.

Parameter
Name Description
var Google\Cloud\Functions\V1\CloudFunction\OnDeployUpdatePolicy
Returns
Type Description
$this

getSourceCode

Returns
Type Description
string

getTrigger

Returns
Type Description
string

getRuntimeUpdatePolicy

Returns
Type Description
string