- 2.55.0 (latest)
- 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
public interface CloudFunctionOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
containsBuildEnvironmentVariables(String key)
public abstract boolean containsBuildEnvironmentVariables(String key)
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)
public abstract boolean containsEnvironmentVariables(String key)
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)
public abstract boolean containsLabels(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 15;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
boolean |
getAvailableMemoryMb()
public abstract int getAvailableMemoryMb()
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()
public abstract Map<String,String> getBuildEnvironmentVariables()
Use #getBuildEnvironmentVariablesMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getBuildEnvironmentVariablesCount()
public abstract int getBuildEnvironmentVariablesCount()
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
Returns | |
---|---|
Type | Description |
int |
getBuildEnvironmentVariablesMap()
public abstract Map<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)
public abstract String getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)
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)
public abstract String getBuildEnvironmentVariablesOrThrow(String key)
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()
public abstract String getBuildId()
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()
public abstract ByteString getBuildIdBytes()
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()
public abstract String getBuildName()
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()
public abstract ByteString getBuildNameBytes()
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. |
getBuildWorkerPool()
public abstract String 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.
string build_worker_pool = 26;
Returns | |
---|---|
Type | Description |
String | The buildWorkerPool. |
getBuildWorkerPoolBytes()
public abstract ByteString getBuildWorkerPoolBytes()
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 |
ByteString | The bytes for buildWorkerPool. |
getDescription()
public abstract String getDescription()
User-provided description of a function.
string description = 2;
Returns | |
---|---|
Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()
User-provided description of a function.
string description = 2;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for description. |
getDockerRegistry()
public abstract CloudFunction.DockerRegistry getDockerRegistry()
Docker Registry to use for this deployment.
If docker_repository
field is specified, this field is 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;
Returns | |
---|---|
Type | Description |
CloudFunction.DockerRegistry | The dockerRegistry. |
getDockerRegistryValue()
public abstract int getDockerRegistryValue()
Docker Registry to use for this deployment.
If docker_repository
field is specified, this field is 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;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for dockerRegistry. |
getDockerRepository()
public abstract String 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 is 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) = { ... }
Returns | |
---|---|
Type | Description |
String | The dockerRepository. |
getDockerRepositoryBytes()
public abstract ByteString getDockerRepositoryBytes()
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 is 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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for dockerRepository. |
getEntryPoint()
public abstract String getEntryPoint()
The name of the function (as defined in source code) that is executed.
Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, the
system tries to use the function named "function".
For Node.js, this is the name of a function exported by the module
as specified in source_location
.
string entry_point = 8;
Returns | |
---|---|
Type | Description |
String | The entryPoint. |
getEntryPointBytes()
public abstract ByteString getEntryPointBytes()
The name of the function (as defined in source code) that is executed.
Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, the
system tries to use the function named "function".
For Node.js, this is the name of a function exported by the module
as specified in source_location
.
string entry_point = 8;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for entryPoint. |
getEnvironmentVariables()
public abstract Map<String,String> getEnvironmentVariables()
Use #getEnvironmentVariablesMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getEnvironmentVariablesCount()
public abstract int getEnvironmentVariablesCount()
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
Returns | |
---|---|
Type | Description |
int |
getEnvironmentVariablesMap()
public abstract Map<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)
public abstract String getEnvironmentVariablesOrDefault(String key, String defaultValue)
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)
public abstract String getEnvironmentVariablesOrThrow(String key)
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()
public abstract EventTrigger getEventTrigger()
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()
public abstract EventTriggerOrBuilder getEventTriggerOrBuilder()
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()
public abstract HttpsTrigger getHttpsTrigger()
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()
public abstract HttpsTriggerOrBuilder getHttpsTriggerOrBuilder()
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()
public abstract CloudFunction.IngressSettings getIngressSettings()
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()
public abstract int getIngressSettingsValue()
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()
public abstract String 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).
- 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()
public abstract ByteString getKmsKeyNameBytes()
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 |
ByteString | The bytes for kmsKeyName. |
getLabels()
public abstract Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public abstract int getLabelsCount()
Labels associated with this Cloud Function.
map<string, string> labels = 15;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public abstract Map<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)
public abstract String getLabelsOrDefault(String key, String defaultValue)
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)
public abstract String getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 15;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getMaxInstances()
public abstract int getMaxInstances()
The limit on the maximum number of function instances that can coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions can for a short period of time create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you might 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()
public abstract int getMinInstances()
A lower bound for the number function instances that can coexist at a given time.
int32 min_instances = 32;
Returns | |
---|---|
Type | Description |
int | The minInstances. |
getName()
public abstract String getName()
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()
public abstract ByteString getNameBytes()
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()
public abstract String getNetwork()
The Serverless VPC Access connector that this cloud function can connect
to. It can be either the fully qualified URI, or the short name of the
connector resource. If the connector name is used, the connector must
belong to the same project as the function. 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;
Returns | |
---|---|
Type | Description |
String | The network. |
getNetworkBytes()
public abstract ByteString getNetworkBytes()
The Serverless VPC Access connector that this cloud function can connect
to. It can be either the fully qualified URI, or the short name of the
connector resource. If the connector name is used, the connector must
belong to the same project as the function. 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;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for network. |
getRuntime()
public abstract String 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.
string runtime = 19;
Returns | |
---|---|
Type | Description |
String | The runtime. |
getRuntimeBytes()
public abstract ByteString getRuntimeBytes()
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 |
ByteString | The bytes for runtime. |
getSecretEnvironmentVariables(int index)
public abstract SecretEnvVar getSecretEnvironmentVariables(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SecretEnvVar |
getSecretEnvironmentVariablesCount()
public abstract int getSecretEnvironmentVariablesCount()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
Returns | |
---|---|
Type | Description |
int |
getSecretEnvironmentVariablesList()
public abstract List<SecretEnvVar> getSecretEnvironmentVariablesList()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
Returns | |
---|---|
Type | Description |
List<SecretEnvVar> |
getSecretEnvironmentVariablesOrBuilder(int index)
public abstract SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SecretEnvVarOrBuilder |
getSecretEnvironmentVariablesOrBuilderList()
public abstract List<? extends SecretEnvVarOrBuilder> 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)
public abstract SecretVolume getSecretVolumes(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SecretVolume |
getSecretVolumesCount()
public abstract int getSecretVolumesCount()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
Returns | |
---|---|
Type | Description |
int |
getSecretVolumesList()
public abstract List<SecretVolume> getSecretVolumesList()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
Returns | |
---|---|
Type | Description |
List<SecretVolume> |
getSecretVolumesOrBuilder(int index)
public abstract SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SecretVolumeOrBuilder |
getSecretVolumesOrBuilderList()
public abstract List<? extends SecretVolumeOrBuilder> 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()
public abstract String getServiceAccountEmail()
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()
public abstract ByteString getServiceAccountEmailBytes()
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()
public abstract String getSourceArchiveUrl()
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()
public abstract ByteString getSourceArchiveUrlBytes()
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()
public abstract CloudFunction.SourceCodeCase getSourceCodeCase()
Returns | |
---|---|
Type | Description |
CloudFunction.SourceCodeCase |
getSourceRepository()
public abstract SourceRepository getSourceRepository()
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()
public abstract SourceRepositoryOrBuilder getSourceRepositoryOrBuilder()
Beta Feature The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
Returns | |
---|---|
Type | Description |
SourceRepositoryOrBuilder |
getSourceToken()
public abstract String getSourceToken()
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()
public abstract ByteString getSourceTokenBytes()
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()
public abstract String 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)
string source_upload_url = 16;
Returns | |
---|---|
Type | Description |
String | The sourceUploadUrl. |
getSourceUploadUrlBytes()
public abstract ByteString getSourceUploadUrlBytes()
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()
public abstract CloudFunctionStatus getStatus()
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()
public abstract int getStatusValue()
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()
public abstract Duration 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.
.google.protobuf.Duration timeout = 9;
Returns | |
---|---|
Type | Description |
Duration | The timeout. |
getTimeoutOrBuilder()
public abstract DurationOrBuilder getTimeoutOrBuilder()
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()
public abstract CloudFunction.TriggerCase getTriggerCase()
Returns | |
---|---|
Type | Description |
CloudFunction.TriggerCase |
getUpdateTime()
public abstract Timestamp getUpdateTime()
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()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()
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()
public abstract long getVersionId()
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()
public abstract String 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.
string vpc_connector = 22;
Returns | |
---|---|
Type | Description |
String | The vpcConnector. |
getVpcConnectorBytes()
public abstract ByteString getVpcConnectorBytes()
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 |
ByteString | The bytes for vpcConnector. |
getVpcConnectorEgressSettings()
public abstract CloudFunction.VpcConnectorEgressSettings getVpcConnectorEgressSettings()
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()
public abstract int getVpcConnectorEgressSettingsValue()
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. |
hasEventTrigger()
public abstract boolean hasEventTrigger()
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()
public abstract boolean hasHttpsTrigger()
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. |
hasSourceArchiveUrl()
public abstract boolean hasSourceArchiveUrl()
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()
public abstract boolean hasSourceRepository()
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()
public abstract boolean hasSourceUploadUrl()
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()
public abstract boolean hasTimeout()
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()
public abstract boolean hasUpdateTime()
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. |