Interface CloudFunctionOrBuilder (2.62.0)
Stay organized with collections Save and categorize content based on your preferences.

publicinterfaceCloudFunctionOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

containsBuildEnvironmentVariables(String key)

publicabstractbooleancontainsBuildEnvironmentVariables(Stringkey)

Build environment variables that shall be available during build time.

map<string, string> build_environment_variables = 28;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsEnvironmentVariables(String key)

publicabstractbooleancontainsEnvironmentVariables(Stringkey)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsLabels(String key)

publicabstractbooleancontainsLabels(Stringkey)

Labels associated with this Cloud Function.

map<string, string> labels = 15;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAutomaticUpdatePolicy()

publicabstractCloudFunction.AutomaticUpdatePolicygetAutomaticUpdatePolicy()

.google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy automatic_update_policy = 40;

Returns
Type	Description
`CloudFunction.AutomaticUpdatePolicy`	The automaticUpdatePolicy.

getAutomaticUpdatePolicyOrBuilder()

publicabstractCloudFunction.AutomaticUpdatePolicyOrBuildergetAutomaticUpdatePolicyOrBuilder()

.google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy automatic_update_policy = 40;

Returns
Type	Description
`CloudFunction.AutomaticUpdatePolicyOrBuilder`

getAvailableMemoryMb()

publicabstractintgetAvailableMemoryMb()

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

int32 available_memory_mb = 10;

Returns
Type	Description
`int`	The availableMemoryMb.

getBuildEnvironmentVariables() (deprecated)

publicabstractMap<String,String>getBuildEnvironmentVariables()

Use #getBuildEnvironmentVariablesMap() instead.

Returns
Type	Description
`Map<String,String>`

getBuildEnvironmentVariablesCount()

publicabstractintgetBuildEnvironmentVariablesCount()

Build environment variables that shall be available during build time.

map<string, string> build_environment_variables = 28;

Returns
Type	Description
`int`

getBuildEnvironmentVariablesMap()

publicabstractMap<String,String>getBuildEnvironmentVariablesMap()

Build environment variables that shall be available during build time.

map<string, string> build_environment_variables = 28;

Returns
Type	Description
`Map<String,String>`

getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)

publicabstractStringgetBuildEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)

Build environment variables that shall be available during build time.

map<string, string> build_environment_variables = 28;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getBuildEnvironmentVariablesOrThrow(String key)

publicabstractStringgetBuildEnvironmentVariablesOrThrow(Stringkey)

Build environment variables that shall be available during build time.

map<string, string> build_environment_variables = 28;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getBuildId()

publicabstractStringgetBuildId()

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

string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The buildId.

getBuildIdBytes()

publicabstractByteStringgetBuildIdBytes()

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

string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for buildId.

getBuildName()

publicabstractStringgetBuildName()

Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.

string build_name = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The buildName.

getBuildNameBytes()

publicabstractByteStringgetBuildNameBytes()

Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.

string build_name = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for buildName.

getBuildServiceAccount()

publicabstractStringgetBuildServiceAccount()

A service account the user provides for use with Cloud Build. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

string build_service_account = 43;

Returns
Type	Description
`String`	The buildServiceAccount.

getBuildServiceAccountBytes()

publicabstractByteStringgetBuildServiceAccountBytes()

A service account the user provides for use with Cloud Build. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

string build_service_account = 43;

Returns
Type	Description
`ByteString`	The bytes for buildServiceAccount.

getBuildWorkerPool()

publicabstractStringgetBuildWorkerPool()

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.

string build_worker_pool = 26;

Returns
Type	Description
`String`	The buildWorkerPool.

getBuildWorkerPoolBytes()

publicabstractByteStringgetBuildWorkerPoolBytes()

string build_worker_pool = 26;

Returns
Type	Description
`ByteString`	The bytes for buildWorkerPool.

getDescription()

publicabstractStringgetDescription()

User-provided description of a function.

string description = 2;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

publicabstractByteStringgetDescriptionBytes()

User-provided description of a function.

string description = 2;

Returns
Type	Description
`ByteString`	The bytes for description.

getDockerRegistry()

publicabstractCloudFunction.DockerRegistrygetDockerRegistry()

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.

.google.cloud.functions.v1.CloudFunction.DockerRegistry docker_registry = 35;

Returns
Type	Description
`CloudFunction.DockerRegistry`	The dockerRegistry.

getDockerRegistryValue()

publicabstractintgetDockerRegistryValue()

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.

.google.cloud.functions.v1.CloudFunction.DockerRegistry docker_registry = 35;

Returns
Type	Description
`int`	The enum numeric value on the wire for dockerRegistry.

getDockerRepository()

publicabstractStringgetDockerRepository()

User-managed repository created in Artifact Registry to which the function's Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and docker_registry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use a default Artifact Registry repository named 'gcf-artifacts' in the region.

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'.

string docker_repository = 34 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The dockerRepository.

getDockerRepositoryBytes()

publicabstractByteStringgetDockerRepositoryBytes()

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'.

string docker_repository = 34 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for dockerRepository.

getEntryPoint()

publicabstractStringgetEntryPoint()

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.

string entry_point = 8;

Returns
Type	Description
`String`	The entryPoint.

getEntryPointBytes()

publicabstractByteStringgetEntryPointBytes()

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.

string entry_point = 8;

Returns
Type	Description
`ByteString`	The bytes for entryPoint.

getEnvironmentVariables() (deprecated)

publicabstractMap<String,String>getEnvironmentVariables()

Use #getEnvironmentVariablesMap() instead.

Returns
Type	Description
`Map<String,String>`

getEnvironmentVariablesCount()

publicabstractintgetEnvironmentVariablesCount()

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 17;

Returns
Type	Description
`int`

getEnvironmentVariablesMap()

publicabstractMap<String,String>getEnvironmentVariablesMap()

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 17;

Returns
Type	Description
`Map<String,String>`

getEnvironmentVariablesOrDefault(String key, String defaultValue)

publicabstractStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 17;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getEnvironmentVariablesOrThrow(String key)

publicabstractStringgetEnvironmentVariablesOrThrow(Stringkey)

Environment variables that shall be available during function execution.

map<string, string> environment_variables = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getEventTrigger()

publicabstractEventTriggergetEventTrigger()

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

.google.cloud.functions.v1.EventTrigger event_trigger = 6;

Returns
Type	Description
`EventTrigger`	The eventTrigger.

getEventTriggerOrBuilder()

publicabstractEventTriggerOrBuildergetEventTriggerOrBuilder()

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

.google.cloud.functions.v1.EventTrigger event_trigger = 6;

Returns
Type	Description
`EventTriggerOrBuilder`

getHttpsTrigger()

publicabstractHttpsTriggergetHttpsTrigger()

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

.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;

Returns
Type	Description
`HttpsTrigger`	The httpsTrigger.

getHttpsTriggerOrBuilder()

publicabstractHttpsTriggerOrBuildergetHttpsTriggerOrBuilder()

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

.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;

Returns
Type	Description
`HttpsTriggerOrBuilder`

getIngressSettings()

publicabstractCloudFunction.IngressSettingsgetIngressSettings()

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

.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;

Returns
Type	Description
`CloudFunction.IngressSettings`	The ingressSettings.

getIngressSettingsValue()

publicabstractintgetIngressSettingsValue()

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

.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;

Returns
Type	Description
`int`	The enum numeric value on the wire for ingressSettings.

getKmsKeyName()

publicabstractStringgetKmsKeyName()

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).

Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
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.

string kms_key_name = 25 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The kmsKeyName.

getKmsKeyNameBytes()

publicabstractByteStringgetKmsKeyNameBytes()

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.

Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
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.

string kms_key_name = 25 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for kmsKeyName.

getLabels() (deprecated)

publicabstractMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

publicabstractintgetLabelsCount()

Labels associated with this Cloud Function.

map<string, string> labels = 15;

Returns
Type	Description
`int`

getLabelsMap()

publicabstractMap<String,String>getLabelsMap()

Labels associated with this Cloud Function.

map<string, string> labels = 15;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

Labels associated with this Cloud Function.

map<string, string> labels = 15;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

publicabstractStringgetLabelsOrThrow(Stringkey)

Labels associated with this Cloud Function.

map<string, string> labels = 15;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getMaxInstances()

publicabstractintgetMaxInstances()

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.

int32 max_instances = 20;

Returns
Type	Description
`int`	The maxInstances.

getMinInstances()

publicabstractintgetMinInstances()

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

int32 min_instances = 32;

Returns
Type	Description
`int`	The minInstances.

getName()

publicabstractStringgetName()

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

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

publicabstractByteStringgetNameBytes()

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

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getNetwork() (deprecated)

publicabstractStringgetNetwork()

Deprecated.google.cloud.functions.v1.CloudFunction.network is deprecated. See google/cloud/functions/v1/functions.proto;l=355

Deprecated: use vpc_connector

string network = 18 [deprecated = true];

Returns
Type	Description
`String`	The network.

getNetworkBytes() (deprecated)

publicabstractByteStringgetNetworkBytes()

Deprecated.google.cloud.functions.v1.CloudFunction.network is deprecated. See google/cloud/functions/v1/functions.proto;l=355

Deprecated: use vpc_connector

string network = 18 [deprecated = true];

Returns
Type	Description
`ByteString`	The bytes for network.

getOnDeployUpdatePolicy()

publicabstractCloudFunction.OnDeployUpdatePolicygetOnDeployUpdatePolicy()

.google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy on_deploy_update_policy = 41;

Returns
Type	Description
`CloudFunction.OnDeployUpdatePolicy`	The onDeployUpdatePolicy.

getOnDeployUpdatePolicyOrBuilder()

publicabstractCloudFunction.OnDeployUpdatePolicyOrBuildergetOnDeployUpdatePolicyOrBuilder()

.google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy on_deploy_update_policy = 41;

Returns
Type	Description
`CloudFunction.OnDeployUpdatePolicyOrBuilder`

getRuntime()

publicabstractStringgetRuntime()

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.

string runtime = 19;

Returns
Type	Description
`String`	The runtime.

getRuntimeBytes()

publicabstractByteStringgetRuntimeBytes()

string runtime = 19;

Returns
Type	Description
`ByteString`	The bytes for runtime.

getRuntimeUpdatePolicyCase()

publicabstractCloudFunction.RuntimeUpdatePolicyCasegetRuntimeUpdatePolicyCase()

Returns
Type	Description
`CloudFunction.RuntimeUpdatePolicyCase`

getSecretEnvironmentVariables(int index)

publicabstractSecretEnvVargetSecretEnvironmentVariables(intindex)

Secret environment variables configuration.

repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SecretEnvVar`

getSecretEnvironmentVariablesCount()

publicabstractintgetSecretEnvironmentVariablesCount()

Secret environment variables configuration.

repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;

Returns
Type	Description
`int`

getSecretEnvironmentVariablesList()

publicabstractList<SecretEnvVar>getSecretEnvironmentVariablesList()

Secret environment variables configuration.

repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;

Returns
Type	Description
`List<SecretEnvVar>`

getSecretEnvironmentVariablesOrBuilder(int index)

publicabstractSecretEnvVarOrBuildergetSecretEnvironmentVariablesOrBuilder(intindex)

Secret environment variables configuration.

repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SecretEnvVarOrBuilder`

getSecretEnvironmentVariablesOrBuilderList()

publicabstractList<?extendsSecretEnvVarOrBuilder>getSecretEnvironmentVariablesOrBuilderList()

Secret environment variables configuration.

repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;

Returns
Type	Description
`List<? extends com.google.cloud.functions.v1.SecretEnvVarOrBuilder>`

getSecretVolumes(int index)

publicabstractSecretVolumegetSecretVolumes(intindex)

Secret volumes configuration.

repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SecretVolume`

getSecretVolumesCount()

publicabstractintgetSecretVolumesCount()

Secret volumes configuration.

repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;

Returns
Type	Description
`int`

getSecretVolumesList()

publicabstractList<SecretVolume>getSecretVolumesList()

Secret volumes configuration.

repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;

Returns
Type	Description
`List<SecretVolume>`

getSecretVolumesOrBuilder(int index)

publicabstractSecretVolumeOrBuildergetSecretVolumesOrBuilder(intindex)

Secret volumes configuration.

repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SecretVolumeOrBuilder`

getSecretVolumesOrBuilderList()

publicabstractList<?extendsSecretVolumeOrBuilder>getSecretVolumesOrBuilderList()

Secret volumes configuration.

repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;

Returns
Type	Description
`List<? extends com.google.cloud.functions.v1.SecretVolumeOrBuilder>`

getServiceAccountEmail()

publicabstractStringgetServiceAccountEmail()

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

string service_account_email = 11;

Returns
Type	Description
`String`	The serviceAccountEmail.

getServiceAccountEmailBytes()

publicabstractByteStringgetServiceAccountEmailBytes()

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

string service_account_email = 11;

Returns
Type	Description
`ByteString`	The bytes for serviceAccountEmail.

getSourceArchiveUrl()

publicabstractStringgetSourceArchiveUrl()

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

string source_archive_url = 3;

Returns
Type	Description
`String`	The sourceArchiveUrl.

getSourceArchiveUrlBytes()

publicabstractByteStringgetSourceArchiveUrlBytes()

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

string source_archive_url = 3;

Returns
Type	Description
`ByteString`	The bytes for sourceArchiveUrl.

getSourceCodeCase()

publicabstractCloudFunction.SourceCodeCasegetSourceCodeCase()

Returns
Type	Description
`CloudFunction.SourceCodeCase`

getSourceRepository()

publicabstractSourceRepositorygetSourceRepository()

Beta Feature

The source repository where a function is hosted.

.google.cloud.functions.v1.SourceRepository source_repository = 4;

Returns
Type	Description
`SourceRepository`	The sourceRepository.

getSourceRepositoryOrBuilder()

publicabstractSourceRepositoryOrBuildergetSourceRepositoryOrBuilder()

Beta Feature

The source repository where a function is hosted.

.google.cloud.functions.v1.SourceRepository source_repository = 4;

Returns
Type	Description
`SourceRepositoryOrBuilder`

getSourceToken()

publicabstractStringgetSourceToken()

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

string source_token = 31 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
`String`	The sourceToken.

getSourceTokenBytes()

publicabstractByteStringgetSourceTokenBytes()

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

string source_token = 31 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for sourceToken.

getSourceUploadUrl()

publicabstractStringgetSourceUploadUrl()

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)

string source_upload_url = 16;

Returns
Type	Description
`String`	The sourceUploadUrl.

getSourceUploadUrlBytes()

publicabstractByteStringgetSourceUploadUrlBytes()

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)

string source_upload_url = 16;

Returns
Type	Description
`ByteString`	The bytes for sourceUploadUrl.

getStatus()

publicabstractCloudFunctionStatusgetStatus()

Output only. Status of the function deployment.

.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`CloudFunctionStatus`	The status.

getStatusValue()

publicabstractintgetStatusValue()

Output only. Status of the function deployment.

.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for status.

getTimeout()

publicabstractDurationgetTimeout()

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.

.google.protobuf.Duration timeout = 9;

Returns
Type	Description
`Duration`	The timeout.

getTimeoutOrBuilder()

publicabstractDurationOrBuildergetTimeoutOrBuilder()

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.

.google.protobuf.Duration timeout = 9;

Returns
Type	Description
`DurationOrBuilder`

getTriggerCase()

publicabstractCloudFunction.TriggerCasegetTriggerCase()

Returns
Type	Description
`CloudFunction.TriggerCase`

getUpdateTime()

publicabstractTimestampgetUpdateTime()

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

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getVersionId()

publicabstractlonggetVersionId()

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

int64 version_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The versionId.

getVpcConnector()

publicabstractStringgetVpcConnector()

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.

string vpc_connector = 22;

Returns
Type	Description
`String`	The vpcConnector.

getVpcConnectorBytes()

publicabstractByteStringgetVpcConnectorBytes()

This field is mutually exclusive with network field and will eventually replace it.

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

string vpc_connector = 22;

Returns
Type	Description
`ByteString`	The bytes for vpcConnector.

getVpcConnectorEgressSettings()

publicabstractCloudFunction.VpcConnectorEgressSettingsgetVpcConnectorEgressSettings()

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

.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23;

Returns
Type	Description
`CloudFunction.VpcConnectorEgressSettings`	The vpcConnectorEgressSettings.

getVpcConnectorEgressSettingsValue()

publicabstractintgetVpcConnectorEgressSettingsValue()

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

.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23;

Returns
Type	Description
`int`	The enum numeric value on the wire for vpcConnectorEgressSettings.

hasAutomaticUpdatePolicy()

publicabstractbooleanhasAutomaticUpdatePolicy()

.google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy automatic_update_policy = 40;

Returns
Type	Description
`boolean`	Whether the automaticUpdatePolicy field is set.

hasEventTrigger()

publicabstractbooleanhasEventTrigger()

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

.google.cloud.functions.v1.EventTrigger event_trigger = 6;

Returns
Type	Description
`boolean`	Whether the eventTrigger field is set.

hasHttpsTrigger()

publicabstractbooleanhasHttpsTrigger()

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

.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;

Returns
Type	Description
`boolean`	Whether the httpsTrigger field is set.

hasOnDeployUpdatePolicy()

publicabstractbooleanhasOnDeployUpdatePolicy()

.google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy on_deploy_update_policy = 41;

Returns
Type	Description
`boolean`	Whether the onDeployUpdatePolicy field is set.

hasSourceArchiveUrl()

publicabstractbooleanhasSourceArchiveUrl()

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

string source_archive_url = 3;

Returns
Type	Description
`boolean`	Whether the sourceArchiveUrl field is set.

hasSourceRepository()

publicabstractbooleanhasSourceRepository()

Beta Feature

The source repository where a function is hosted.

.google.cloud.functions.v1.SourceRepository source_repository = 4;

Returns
Type	Description
`boolean`	Whether the sourceRepository field is set.

hasSourceUploadUrl()

publicabstractbooleanhasSourceUploadUrl()

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)

string source_upload_url = 16;

Returns
Type	Description
`boolean`	Whether the sourceUploadUrl field is set.

hasTimeout()

publicabstractbooleanhasTimeout()

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.

.google.protobuf.Duration timeout = 9;

Returns
Type	Description
`boolean`	Whether the timeout field is set.

hasUpdateTime()

publicabstractbooleanhasUpdateTime()

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

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

Interface CloudFunctionOrBuilder (2.62.0) Stay organized with collections Save and categorize content based on your preferences.

Implements

Methods

containsBuildEnvironmentVariables(String key)

containsEnvironmentVariables(String key)

containsLabels(String key)

getAutomaticUpdatePolicy()

getAutomaticUpdatePolicyOrBuilder()

getAvailableMemoryMb()

getBuildEnvironmentVariables() (deprecated)

getBuildEnvironmentVariablesCount()

getBuildEnvironmentVariablesMap()

getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)

getBuildEnvironmentVariablesOrThrow(String key)

getBuildId()

getBuildIdBytes()

getBuildName()

getBuildNameBytes()

getBuildServiceAccount()

getBuildServiceAccountBytes()

getBuildWorkerPool()

getBuildWorkerPoolBytes()

getDescription()

getDescriptionBytes()

getDockerRegistry()

getDockerRegistryValue()

getDockerRepository()

getDockerRepositoryBytes()

getEntryPoint()

getEntryPointBytes()

getEnvironmentVariables() (deprecated)

getEnvironmentVariablesCount()

getEnvironmentVariablesMap()

getEnvironmentVariablesOrDefault(String key, String defaultValue)

getEnvironmentVariablesOrThrow(String key)

getEventTrigger()

getEventTriggerOrBuilder()

getHttpsTrigger()

getHttpsTriggerOrBuilder()

getIngressSettings()

getIngressSettingsValue()

getKmsKeyName()

getKmsKeyNameBytes()

getLabels() (deprecated)

getLabelsCount()

getLabelsMap()

getLabelsOrDefault(String key, String defaultValue)

getLabelsOrThrow(String key)

getMaxInstances()

getMinInstances()

getName()

getNameBytes()

getNetwork() (deprecated)

getNetworkBytes() (deprecated)

getOnDeployUpdatePolicy()

getOnDeployUpdatePolicyOrBuilder()

getRuntime()

getRuntimeBytes()

getRuntimeUpdatePolicyCase()

getSecretEnvironmentVariables(int index)

getSecretEnvironmentVariablesCount()

getSecretEnvironmentVariablesList()

getSecretEnvironmentVariablesOrBuilder(int index)

getSecretEnvironmentVariablesOrBuilderList()

getSecretVolumes(int index)

getSecretVolumesCount()

getSecretVolumesList()

getSecretVolumesOrBuilder(int index)

getSecretVolumesOrBuilderList()

getServiceAccountEmail()

getServiceAccountEmailBytes()

getSourceArchiveUrl()

getSourceArchiveUrlBytes()

getSourceCodeCase()

getSourceRepository()

getSourceRepositoryOrBuilder()

getSourceToken()

getSourceTokenBytes()

getSourceUploadUrl()

getSourceUploadUrlBytes()

Interface CloudFunctionOrBuilder (2.62.0)
Stay organized with collections Save and categorize content based on your preferences.