Class CloudFunction (2.14.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
publicfinalclass CloudFunctionextendsGeneratedMessageV3implementsCloudFunctionOrBuilderDescribes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.
Protobuf type google.cloud.functions.v1.CloudFunction
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CloudFunctionImplements
CloudFunctionOrBuilderInherited Members
Static Fields
AVAILABLE_MEMORY_MB_FIELD_NUMBER
publicstaticfinalintAVAILABLE_MEMORY_MB_FIELD_NUMBERBUILD_ENVIRONMENT_VARIABLES_FIELD_NUMBER
publicstaticfinalintBUILD_ENVIRONMENT_VARIABLES_FIELD_NUMBERBUILD_ID_FIELD_NUMBER
publicstaticfinalintBUILD_ID_FIELD_NUMBERBUILD_NAME_FIELD_NUMBER
publicstaticfinalintBUILD_NAME_FIELD_NUMBERBUILD_WORKER_POOL_FIELD_NUMBER
publicstaticfinalintBUILD_WORKER_POOL_FIELD_NUMBERDESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_FIELD_NUMBERDOCKER_REGISTRY_FIELD_NUMBER
publicstaticfinalintDOCKER_REGISTRY_FIELD_NUMBERDOCKER_REPOSITORY_FIELD_NUMBER
publicstaticfinalintDOCKER_REPOSITORY_FIELD_NUMBERENTRY_POINT_FIELD_NUMBER
publicstaticfinalintENTRY_POINT_FIELD_NUMBERENVIRONMENT_VARIABLES_FIELD_NUMBER
publicstaticfinalintENVIRONMENT_VARIABLES_FIELD_NUMBEREVENT_TRIGGER_FIELD_NUMBER
publicstaticfinalintEVENT_TRIGGER_FIELD_NUMBERHTTPS_TRIGGER_FIELD_NUMBER
publicstaticfinalintHTTPS_TRIGGER_FIELD_NUMBERINGRESS_SETTINGS_FIELD_NUMBER
publicstaticfinalintINGRESS_SETTINGS_FIELD_NUMBERKMS_KEY_NAME_FIELD_NUMBER
publicstaticfinalintKMS_KEY_NAME_FIELD_NUMBERLABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBERMAX_INSTANCES_FIELD_NUMBER
publicstaticfinalintMAX_INSTANCES_FIELD_NUMBERMIN_INSTANCES_FIELD_NUMBER
publicstaticfinalintMIN_INSTANCES_FIELD_NUMBERNAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBERNETWORK_FIELD_NUMBER
publicstaticfinalintNETWORK_FIELD_NUMBERRUNTIME_FIELD_NUMBER
publicstaticfinalintRUNTIME_FIELD_NUMBERSECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER
publicstaticfinalintSECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBERSECRET_VOLUMES_FIELD_NUMBER
publicstaticfinalintSECRET_VOLUMES_FIELD_NUMBERSERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
publicstaticfinalintSERVICE_ACCOUNT_EMAIL_FIELD_NUMBERSOURCE_ARCHIVE_URL_FIELD_NUMBER
publicstaticfinalintSOURCE_ARCHIVE_URL_FIELD_NUMBERSOURCE_REPOSITORY_FIELD_NUMBER
publicstaticfinalintSOURCE_REPOSITORY_FIELD_NUMBERSOURCE_TOKEN_FIELD_NUMBER
publicstaticfinalintSOURCE_TOKEN_FIELD_NUMBERSOURCE_UPLOAD_URL_FIELD_NUMBER
publicstaticfinalintSOURCE_UPLOAD_URL_FIELD_NUMBERSTATUS_FIELD_NUMBER
publicstaticfinalintSTATUS_FIELD_NUMBERTIMEOUT_FIELD_NUMBER
publicstaticfinalintTIMEOUT_FIELD_NUMBERUPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBERVERSION_ID_FIELD_NUMBER
publicstaticfinalintVERSION_ID_FIELD_NUMBERVPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER
publicstaticfinalintVPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBERVPC_CONNECTOR_FIELD_NUMBER
publicstaticfinalintVPC_CONNECTOR_FIELD_NUMBERStatic Methods
getDefaultInstance()
publicstaticCloudFunctiongetDefaultInstance()getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()newBuilder()
publicstaticCloudFunction.BuildernewBuilder()newBuilder(CloudFunction prototype)
publicstaticCloudFunction.BuildernewBuilder(CloudFunctionprototype)parseDelimitedFrom(InputStream input)
publicstaticCloudFunctionparseDelimitedFrom(InputStreaminput)parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticCloudFunctionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(byte[] data)
publicstaticCloudFunctionparseFrom(byte[]data)data
byte[]parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticCloudFunctionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)data
byte[]parseFrom(ByteString data)
publicstaticCloudFunctionparseFrom(ByteStringdata)parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticCloudFunctionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)parseFrom(CodedInputStream input)
publicstaticCloudFunctionparseFrom(CodedInputStreaminput)parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticCloudFunctionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(InputStream input)
publicstaticCloudFunctionparseFrom(InputStreaminput)parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticCloudFunctionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(ByteBuffer data)
publicstaticCloudFunctionparseFrom(ByteBufferdata)parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticCloudFunctionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)parser()
publicstaticParser<CloudFunction>parser()Methods
containsBuildEnvironmentVariables(String key)
publicbooleancontainsBuildEnvironmentVariables(Stringkey)Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
containsEnvironmentVariables(String key)
publicbooleancontainsEnvironmentVariables(Stringkey)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)Labels associated with this Cloud Function.
map<string, string> labels = 15;
equals(Object obj)
publicbooleanequals(Objectobj)getAvailableMemoryMb()
publicintgetAvailableMemoryMb()The amount of memory in MB available for a function. Defaults to 256MB.
int32 available_memory_mb = 10;
int
The availableMemoryMb.
getBuildEnvironmentVariables()
publicMap<String,String>getBuildEnvironmentVariables()Use #getBuildEnvironmentVariablesMap() instead.
getBuildEnvironmentVariablesCount()
publicintgetBuildEnvironmentVariablesCount()Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
getBuildEnvironmentVariablesMap()
publicMap<String,String>getBuildEnvironmentVariablesMap()Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)
publicStringgetBuildEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
getBuildEnvironmentVariablesOrThrow(String key)
publicStringgetBuildEnvironmentVariablesOrThrow(Stringkey)Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
getBuildId()
publicStringgetBuildId()Output only. The Cloud Build ID of the latest successful deployment of the function.
string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
String
The buildId.
getBuildIdBytes()
publicByteStringgetBuildIdBytes()Output only. The Cloud Build ID of the latest successful deployment of the function.
string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
ByteString
The bytes for buildId.
getBuildName()
publicStringgetBuildName() 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];
String
The buildName.
getBuildNameBytes()
publicByteStringgetBuildNameBytes() 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];
ByteString
The bytes for buildName.
getBuildWorkerPool()
publicStringgetBuildWorkerPool() 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;
String
The buildWorkerPool.
getBuildWorkerPoolBytes()
publicByteStringgetBuildWorkerPoolBytes() 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;
ByteString
The bytes for buildWorkerPool.
getDefaultInstanceForType()
publicCloudFunctiongetDefaultInstanceForType()getDescription()
publicStringgetDescription()User-provided description of a function.
string description = 2;
String
The description.
getDescriptionBytes()
publicByteStringgetDescriptionBytes()User-provided description of a function.
string description = 2;
ByteString
The bytes for description.
getDockerRegistry()
publicCloudFunction.DockerRegistrygetDockerRegistry() Docker Registry to use for this deployment.
If docker_repository field is specified, this field will be automatically
set as ARTIFACT_REGISTRY.
If unspecified, it currently defaults to CONTAINER_REGISTRY.
This field may be overridden by the backend for eligible deployments.
.google.cloud.functions.v1.CloudFunction.DockerRegistry docker_registry = 35;
CloudFunction.DockerRegistry
The dockerRegistry.
getDockerRegistryValue()
publicintgetDockerRegistryValue() Docker Registry to use for this deployment.
If docker_repository field is specified, this field will be automatically
set as ARTIFACT_REGISTRY.
If unspecified, it currently defaults to CONTAINER_REGISTRY.
This field may be overridden by the backend for eligible deployments.
.google.cloud.functions.v1.CloudFunction.DockerRegistry docker_registry = 35;
int
The enum numeric value on the wire for dockerRegistry.
getDockerRepository()
publicStringgetDockerRepository() 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'.
string docker_repository = 34 [(.google.api.resource_reference) = { ... }
String
The dockerRepository.
getDockerRepositoryBytes()
publicByteStringgetDockerRepositoryBytes() 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'.
string docker_repository = 34 [(.google.api.resource_reference) = { ... }
ByteString
The bytes for dockerRepository.
getEntryPoint()
publicStringgetEntryPoint() The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 8;
String
The entryPoint.
getEntryPointBytes()
publicByteStringgetEntryPointBytes() The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 8;
ByteString
The bytes for entryPoint.
getEnvironmentVariables()
publicMap<String,String>getEnvironmentVariables()Use #getEnvironmentVariablesMap() instead.
getEnvironmentVariablesCount()
publicintgetEnvironmentVariablesCount()Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
getEnvironmentVariablesMap()
publicMap<String,String>getEnvironmentVariablesMap()Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
getEnvironmentVariablesOrDefault(String key, String defaultValue)
publicStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
getEnvironmentVariablesOrThrow(String key)
publicStringgetEnvironmentVariablesOrThrow(Stringkey)Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
getEventTrigger()
publicEventTriggergetEventTrigger()A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;
EventTrigger
The eventTrigger.
getEventTriggerOrBuilder()
publicEventTriggerOrBuildergetEventTriggerOrBuilder()A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;
getHttpsTrigger()
publicHttpsTriggergetHttpsTrigger()An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
HttpsTrigger
The httpsTrigger.
getHttpsTriggerOrBuilder()
publicHttpsTriggerOrBuildergetHttpsTriggerOrBuilder()An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
getIngressSettings()
publicCloudFunction.IngressSettingsgetIngressSettings()The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;
CloudFunction.IngressSettings
The ingressSettings.
getIngressSettingsValue()
publicintgetIngressSettingsValue()The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;
int
The enum numeric value on the wire for ingressSettings.
getKmsKeyName()
publicStringgetKmsKeyName() 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) = { ... }
String
The kmsKeyName.
getKmsKeyNameBytes()
publicByteStringgetKmsKeyNameBytes() 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) = { ... }
ByteString
The bytes for kmsKeyName.
getLabels()
publicMap<String,String>getLabels()Use #getLabelsMap() instead.
getLabelsCount()
publicintgetLabelsCount()Labels associated with this Cloud Function.
map<string, string> labels = 15;
getLabelsMap()
publicMap<String,String>getLabelsMap()Labels associated with this Cloud Function.
map<string, string> labels = 15;
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)Labels associated with this Cloud Function.
map<string, string> labels = 15;
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)Labels associated with this Cloud Function.
map<string, string> labels = 15;
getMaxInstances()
publicintgetMaxInstances()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;
int
The maxInstances.
getMinInstances()
publicintgetMinInstances()A lower bound for the number function instances that may coexist at a given time.
int32 min_instances = 32;
int
The minInstances.
getName()
publicStringgetName() A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
string name = 1;
String
The name.
getNameBytes()
publicByteStringgetNameBytes() A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
string name = 1;
ByteString
The bytes for name.
getNetwork()
publicStringgetNetwork() The VPC Network that this cloud function can connect to. It can be
either the fully-qualified URI, or the short name of the network resource.
If the short network name is used, the network must belong to the same
project. Otherwise, it must belong to a project within the same
organization. The format of this field is either
projects/{project}/global/networks/{network} or {network}, where
{project} is a project id where the network is defined, and {network}
is the short name of the network.
This field is mutually exclusive with vpc_connector and will be replaced
by it.
See the VPC documentation for
more information on connecting Cloud projects.
string network = 18;
String
The network.
getNetworkBytes()
publicByteStringgetNetworkBytes() The VPC Network that this cloud function can connect to. It can be
either the fully-qualified URI, or the short name of the network resource.
If the short network name is used, the network must belong to the same
project. Otherwise, it must belong to a project within the same
organization. The format of this field is either
projects/{project}/global/networks/{network} or {network}, where
{project} is a project id where the network is defined, and {network}
is the short name of the network.
This field is mutually exclusive with vpc_connector and will be replaced
by it.
See the VPC documentation for
more information on connecting Cloud projects.
string network = 18;
ByteString
The bytes for network.
getParserForType()
publicParser<CloudFunction>getParserForType()getRuntime()
publicStringgetRuntime() 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;
String
The runtime.
getRuntimeBytes()
publicByteStringgetRuntimeBytes() 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;
ByteString
The bytes for runtime.
getSecretEnvironmentVariables(int index)
publicSecretEnvVargetSecretEnvironmentVariables(intindex)Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesCount()
publicintgetSecretEnvironmentVariablesCount()Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesList()
publicList<SecretEnvVar>getSecretEnvironmentVariablesList()Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesOrBuilder(int index)
publicSecretEnvVarOrBuildergetSecretEnvironmentVariablesOrBuilder(intindex)Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesOrBuilderList()
publicList<?extendsSecretEnvVarOrBuilder>getSecretEnvironmentVariablesOrBuilderList()Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
List<? extends com.google.cloud.functions.v1.SecretEnvVarOrBuilder>
getSecretVolumes(int index)
publicSecretVolumegetSecretVolumes(intindex)Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
getSecretVolumesCount()
publicintgetSecretVolumesCount()Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
getSecretVolumesList()
publicList<SecretVolume>getSecretVolumesList()Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
getSecretVolumesOrBuilder(int index)
publicSecretVolumeOrBuildergetSecretVolumesOrBuilder(intindex)Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
getSecretVolumesOrBuilderList()
publicList<?extendsSecretVolumeOrBuilder>getSecretVolumesOrBuilderList()Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
List<? extends com.google.cloud.functions.v1.SecretVolumeOrBuilder>
getSerializedSize()
publicintgetSerializedSize()getServiceAccountEmail()
publicStringgetServiceAccountEmail() The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com.
string service_account_email = 11;
String
The serviceAccountEmail.
getServiceAccountEmailBytes()
publicByteStringgetServiceAccountEmailBytes() The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com.
string service_account_email = 11;
ByteString
The bytes for serviceAccountEmail.
getSourceArchiveUrl()
publicStringgetSourceArchiveUrl() The Google Cloud Storage URL, starting with gs://, pointing to the zip
archive which contains the function.
string source_archive_url = 3;
String
The sourceArchiveUrl.
getSourceArchiveUrlBytes()
publicByteStringgetSourceArchiveUrlBytes() The Google Cloud Storage URL, starting with gs://, pointing to the zip
archive which contains the function.
string source_archive_url = 3;
ByteString
The bytes for sourceArchiveUrl.
getSourceCodeCase()
publicCloudFunction.SourceCodeCasegetSourceCodeCase()getSourceRepository()
publicSourceRepositorygetSourceRepository()Beta Feature The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
SourceRepository
The sourceRepository.
getSourceRepositoryOrBuilder()
publicSourceRepositoryOrBuildergetSourceRepositoryOrBuilder()Beta Feature The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
getSourceToken()
publicStringgetSourceToken()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];
String
The sourceToken.
getSourceTokenBytes()
publicByteStringgetSourceTokenBytes()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];
ByteString
The bytes for sourceToken.
getSourceUploadUrl()
publicStringgetSourceUploadUrl()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;
String
The sourceUploadUrl.
getSourceUploadUrlBytes()
publicByteStringgetSourceUploadUrlBytes()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;
ByteString
The bytes for sourceUploadUrl.
getStatus()
publicCloudFunctionStatusgetStatus()Output only. Status of the function deployment.
.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
CloudFunctionStatus
The status.
getStatusValue()
publicintgetStatusValue()Output only. Status of the function deployment.
.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
The enum numeric value on the wire for status.
getTimeout()
publicDurationgetTimeout()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;
Duration
The timeout.
getTimeoutOrBuilder()
publicDurationOrBuildergetTimeoutOrBuilder()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;
getTriggerCase()
publicCloudFunction.TriggerCasegetTriggerCase()getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()getUpdateTime()
publicTimestampgetUpdateTime()Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Timestamp
The updateTime.
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVersionId()
publiclonggetVersionId()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];
long
The versionId.
getVpcConnector()
publicStringgetVpcConnector() 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;
String
The vpcConnector.
getVpcConnectorBytes()
publicByteStringgetVpcConnectorBytes() 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;
ByteString
The bytes for vpcConnector.
getVpcConnectorEgressSettings()
publicCloudFunction.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;
CloudFunction.VpcConnectorEgressSettings
The vpcConnectorEgressSettings.
getVpcConnectorEgressSettingsValue()
publicintgetVpcConnectorEgressSettingsValue()The egress settings for the connector, controlling what traffic is diverted through it.
.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23;
int
The enum numeric value on the wire for vpcConnectorEgressSettings.
hasEventTrigger()
publicbooleanhasEventTrigger()A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;
boolean
Whether the eventTrigger field is set.
hasHttpsTrigger()
publicbooleanhasHttpsTrigger()An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
boolean
Whether the httpsTrigger field is set.
hasSourceArchiveUrl()
publicbooleanhasSourceArchiveUrl() The Google Cloud Storage URL, starting with gs://, pointing to the zip
archive which contains the function.
string source_archive_url = 3;
boolean
Whether the sourceArchiveUrl field is set.
hasSourceRepository()
publicbooleanhasSourceRepository()Beta Feature The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
boolean
Whether the sourceRepository field is set.
hasSourceUploadUrl()
publicbooleanhasSourceUploadUrl()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;
boolean
Whether the sourceUploadUrl field is set.
hasTimeout()
publicbooleanhasTimeout()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;
boolean
Whether the timeout field is set.
hasUpdateTime()
publicbooleanhasUpdateTime()Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean
Whether the updateTime field is set.
hashCode()
publicinthashCode()internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)isInitialized()
publicfinalbooleanisInitialized()newBuilderForType()
publicCloudFunction.BuildernewBuilderForType()newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedCloudFunction.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)toBuilder()
publicCloudFunction.BuildertoBuilder()writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)