Package com.google.cloud.functions.v1
Interface CloudFunctionOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
CloudFunction
,CloudFunction.Builder
public interface CloudFunctionOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
containsBuildEnvironmentVariables(String key)
Build environment variables that shall be available during build time.boolean
containsEnvironmentVariables(String key)
Environment variables that shall be available during function execution.boolean
containsLabels(String key)
Labels associated with this Cloud Function.int
getAvailableMemoryMb()
The amount of memory in MB available for a function.Map<String,String>
getBuildEnvironmentVariables()
Deprecated.int
getBuildEnvironmentVariablesCount()
Build environment variables that shall be available during build time.Map<String,String>
getBuildEnvironmentVariablesMap()
Build environment variables that shall be available during build time.String
getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)
Build environment variables that shall be available during build time.String
getBuildEnvironmentVariablesOrThrow(String key)
Build environment variables that shall be available during build time.String
getBuildId()
Output only.com.google.protobuf.ByteString
getBuildIdBytes()
Output only.String
getBuildName()
Output only.com.google.protobuf.ByteString
getBuildNameBytes()
Output only.String
getBuildWorkerPool()
Name of the Cloud Build Custom Worker Pool that should be used to build the function.com.google.protobuf.ByteString
getBuildWorkerPoolBytes()
Name of the Cloud Build Custom Worker Pool that should be used to build the function.String
getDescription()
User-provided description of a function.com.google.protobuf.ByteString
getDescriptionBytes()
User-provided description of a function.CloudFunction.DockerRegistry
getDockerRegistry()
Docker Registry to use for this deployment.int
getDockerRegistryValue()
Docker Registry to use for this deployment.String
getDockerRepository()
User managed repository created in Artifact Registry optionally with a customer managed encryption key.com.google.protobuf.ByteString
getDockerRepositoryBytes()
User managed repository created in Artifact Registry optionally with a customer managed encryption key.String
getEntryPoint()
The name of the function (as defined in source code) that is executed.com.google.protobuf.ByteString
getEntryPointBytes()
The name of the function (as defined in source code) that is executed.Map<String,String>
getEnvironmentVariables()
Deprecated.int
getEnvironmentVariablesCount()
Environment variables that shall be available during function execution.Map<String,String>
getEnvironmentVariablesMap()
Environment variables that shall be available during function execution.String
getEnvironmentVariablesOrDefault(String key, String defaultValue)
Environment variables that shall be available during function execution.String
getEnvironmentVariablesOrThrow(String key)
Environment variables that shall be available during function execution.EventTrigger
getEventTrigger()
A source that fires events in response to a condition in another service.EventTriggerOrBuilder
getEventTriggerOrBuilder()
A source that fires events in response to a condition in another service.HttpsTrigger
getHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.HttpsTriggerOrBuilder
getHttpsTriggerOrBuilder()
An HTTPS endpoint type of source that can be triggered via URL.CloudFunction.IngressSettings
getIngressSettings()
The ingress settings for the function, controlling what traffic can reach it.int
getIngressSettingsValue()
The ingress settings for the function, controlling what traffic can reach it.String
getKmsKeyName()
Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.com.google.protobuf.ByteString
getKmsKeyNameBytes()
Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
Labels associated with this Cloud Function.Map<String,String>
getLabelsMap()
Labels associated with this Cloud Function.String
getLabelsOrDefault(String key, String defaultValue)
Labels associated with this Cloud Function.String
getLabelsOrThrow(String key)
Labels associated with this Cloud Function.int
getMaxInstances()
The limit on the maximum number of function instances that can coexist at a given time.int
getMinInstances()
A lower bound for the number function instances that can coexist at a given time.String
getName()
A user-defined name of the function.com.google.protobuf.ByteString
getNameBytes()
A user-defined name of the function.String
getNetwork()
The Serverless VPC Access connector that this cloud function can connect to.com.google.protobuf.ByteString
getNetworkBytes()
The Serverless VPC Access connector that this cloud function can connect to.String
getRuntime()
The runtime in which to run the function.com.google.protobuf.ByteString
getRuntimeBytes()
The runtime in which to run the function.SecretEnvVar
getSecretEnvironmentVariables(int index)
Secret environment variables configuration.int
getSecretEnvironmentVariablesCount()
Secret environment variables configuration.List<SecretEnvVar>
getSecretEnvironmentVariablesList()
Secret environment variables configuration.SecretEnvVarOrBuilder
getSecretEnvironmentVariablesOrBuilder(int index)
Secret environment variables configuration.List<? extends SecretEnvVarOrBuilder>
getSecretEnvironmentVariablesOrBuilderList()
Secret environment variables configuration.SecretVolume
getSecretVolumes(int index)
Secret volumes configuration.int
getSecretVolumesCount()
Secret volumes configuration.List<SecretVolume>
getSecretVolumesList()
Secret volumes configuration.SecretVolumeOrBuilder
getSecretVolumesOrBuilder(int index)
Secret volumes configuration.List<? extends SecretVolumeOrBuilder>
getSecretVolumesOrBuilderList()
Secret volumes configuration.String
getServiceAccountEmail()
The email of the function's service account.com.google.protobuf.ByteString
getServiceAccountEmailBytes()
The email of the function's service account.String
getSourceArchiveUrl()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.com.google.protobuf.ByteString
getSourceArchiveUrlBytes()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.CloudFunction.SourceCodeCase
getSourceCodeCase()
SourceRepository
getSourceRepository()
**Beta Feature** The source repository where a function is hosted.SourceRepositoryOrBuilder
getSourceRepositoryOrBuilder()
**Beta Feature** The source repository where a function is hosted.String
getSourceToken()
Input only.com.google.protobuf.ByteString
getSourceTokenBytes()
Input only.String
getSourceUploadUrl()
The Google Cloud Storage-signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].com.google.protobuf.ByteString
getSourceUploadUrlBytes()
The Google Cloud Storage-signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].CloudFunctionStatus
getStatus()
Output only.int
getStatusValue()
Output only.com.google.protobuf.Duration
getTimeout()
The function execution timeout.com.google.protobuf.DurationOrBuilder
getTimeoutOrBuilder()
The function execution timeout.CloudFunction.TriggerCase
getTriggerCase()
com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.long
getVersionId()
Output only.String
getVpcConnector()
The VPC Network Connector that this cloud function can connect to.com.google.protobuf.ByteString
getVpcConnectorBytes()
The VPC Network Connector that this cloud function can connect to.CloudFunction.VpcConnectorEgressSettings
getVpcConnectorEgressSettings()
The egress settings for the connector, controlling what traffic is diverted through it.int
getVpcConnectorEgressSettingsValue()
The egress settings for the connector, controlling what traffic is diverted through it.boolean
hasEventTrigger()
A source that fires events in response to a condition in another service.boolean
hasHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.boolean
hasSourceArchiveUrl()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.boolean
hasSourceRepository()
**Beta Feature** The source repository where a function is hosted.boolean
hasSourceUploadUrl()
The Google Cloud Storage-signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].boolean
hasTimeout()
The function execution timeout.boolean
hasUpdateTime()
Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
getDescription
String getDescription()
User-provided description of a function.
string description = 2;
- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
User-provided description of a function.
string description = 2;
- Returns:
- The bytes for description.
-
hasSourceArchiveUrl
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:
- Whether the sourceArchiveUrl field is set.
-
getSourceArchiveUrl
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:
- The sourceArchiveUrl.
-
getSourceArchiveUrlBytes
com.google.protobuf.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:
- The bytes for sourceArchiveUrl.
-
hasSourceRepository
boolean hasSourceRepository()
**Beta Feature** The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
- Returns:
- Whether the sourceRepository field is set.
-
getSourceRepository
SourceRepository getSourceRepository()
**Beta Feature** The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
- Returns:
- The sourceRepository.
-
getSourceRepositoryOrBuilder
SourceRepositoryOrBuilder getSourceRepositoryOrBuilder()
**Beta Feature** The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;
-
hasSourceUploadUrl
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:
- Whether the sourceUploadUrl field is set.
-
getSourceUploadUrl
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:
- The sourceUploadUrl.
-
getSourceUploadUrlBytes
com.google.protobuf.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:
- The bytes for sourceUploadUrl.
-
hasHttpsTrigger
boolean hasHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
- Returns:
- Whether the httpsTrigger field is set.
-
getHttpsTrigger
HttpsTrigger getHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
- Returns:
- The httpsTrigger.
-
getHttpsTriggerOrBuilder
HttpsTriggerOrBuilder getHttpsTriggerOrBuilder()
An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
-
hasEventTrigger
boolean hasEventTrigger()
A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;
- Returns:
- Whether the eventTrigger field is set.
-
getEventTrigger
EventTrigger getEventTrigger()
A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;
- Returns:
- The eventTrigger.
-
getEventTriggerOrBuilder
EventTriggerOrBuilder getEventTriggerOrBuilder()
A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;
-
getStatusValue
int getStatusValue()
Output only. Status of the function deployment.
.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The enum numeric value on the wire for status.
-
getStatus
CloudFunctionStatus getStatus()
Output only. Status of the function deployment.
.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The status.
-
getEntryPoint
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:
- The entryPoint.
-
getEntryPointBytes
com.google.protobuf.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:
- The bytes for entryPoint.
-
getRuntime
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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string runtime = 19;
- Returns:
- The runtime.
-
getRuntimeBytes
com.google.protobuf.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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string runtime = 19;
- Returns:
- The bytes for runtime.
-
hasTimeout
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:
- Whether the timeout field is set.
-
getTimeout
com.google.protobuf.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:
- The timeout.
-
getTimeoutOrBuilder
com.google.protobuf.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;
-
getAvailableMemoryMb
int getAvailableMemoryMb()
The amount of memory in MB available for a function. Defaults to 256MB.
int32 available_memory_mb = 10;
- Returns:
- The availableMemoryMb.
-
getServiceAccountEmail
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:
- The serviceAccountEmail.
-
getServiceAccountEmailBytes
com.google.protobuf.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:
- The bytes for serviceAccountEmail.
-
hasUpdateTime
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:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.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:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getVersionId
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:
- The versionId.
-
getLabelsCount
int getLabelsCount()
Labels associated with this Cloud Function.
map<string, string> labels = 15;
-
containsLabels
boolean containsLabels(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 15;
-
getLabels
@Deprecated Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.
-
getLabelsMap
Map<String,String> getLabelsMap()
Labels associated with this Cloud Function.
map<string, string> labels = 15;
-
getLabelsOrDefault
String getLabelsOrDefault(String key, String defaultValue)
Labels associated with this Cloud Function.
map<string, string> labels = 15;
-
getLabelsOrThrow
String getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 15;
-
getEnvironmentVariablesCount
int getEnvironmentVariablesCount()
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
-
containsEnvironmentVariables
boolean containsEnvironmentVariables(String key)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
-
getEnvironmentVariables
@Deprecated Map<String,String> getEnvironmentVariables()
Deprecated.UsegetEnvironmentVariablesMap()
instead.
-
getEnvironmentVariablesMap
Map<String,String> getEnvironmentVariablesMap()
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
-
getEnvironmentVariablesOrDefault
String getEnvironmentVariablesOrDefault(String key, String defaultValue)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
-
getEnvironmentVariablesOrThrow
String getEnvironmentVariablesOrThrow(String key)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;
-
getBuildEnvironmentVariablesCount
int getBuildEnvironmentVariablesCount()
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
-
containsBuildEnvironmentVariables
boolean containsBuildEnvironmentVariables(String key)
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
-
getBuildEnvironmentVariables
@Deprecated Map<String,String> getBuildEnvironmentVariables()
Deprecated.UsegetBuildEnvironmentVariablesMap()
instead.
-
getBuildEnvironmentVariablesMap
Map<String,String> getBuildEnvironmentVariablesMap()
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
-
getBuildEnvironmentVariablesOrDefault
String getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
-
getBuildEnvironmentVariablesOrThrow
String getBuildEnvironmentVariablesOrThrow(String key)
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;
-
getNetwork
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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string network = 18;
- Returns:
- The network.
-
getNetworkBytes
com.google.protobuf.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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string network = 18;
- Returns:
- The bytes for network.
-
getMaxInstances
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](https://cloud.google.com/functions/docs/max-instances) Guide for more details.
int32 max_instances = 20;
- Returns:
- The maxInstances.
-
getMinInstances
int getMinInstances()
A lower bound for the number function instances that can coexist at a given time.
int32 min_instances = 32;
- Returns:
- The minInstances.
-
getVpcConnector
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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string vpc_connector = 22;
- Returns:
- The vpcConnector.
-
getVpcConnectorBytes
com.google.protobuf.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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string vpc_connector = 22;
- Returns:
- The bytes for vpcConnector.
-
getVpcConnectorEgressSettingsValue
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:
- The enum numeric value on the wire for vpcConnectorEgressSettings.
-
getVpcConnectorEgressSettings
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:
- The vpcConnectorEgressSettings.
-
getIngressSettingsValue
int getIngressSettingsValue()
The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;
- Returns:
- The enum numeric value on the wire for ingressSettings.
-
getIngressSettings
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:
- The ingressSettings.
-
getKmsKeyName
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). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.
string kms_key_name = 25 [(.google.api.resource_reference) = { ... }
- Returns:
- The kmsKeyName.
-
getKmsKeyNameBytes
com.google.protobuf.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). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.
string kms_key_name = 25 [(.google.api.resource_reference) = { ... }
- Returns:
- The bytes for kmsKeyName.
-
getBuildWorkerPool
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:
- The buildWorkerPool.
-
getBuildWorkerPoolBytes
com.google.protobuf.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:
- The bytes for buildWorkerPool.
-
getBuildId
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:
- The buildId.
-
getBuildIdBytes
com.google.protobuf.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:
- The bytes for buildId.
-
getBuildName
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:
- The buildName.
-
getBuildNameBytes
com.google.protobuf.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:
- The bytes for buildName.
-
getSecretEnvironmentVariablesList
List<SecretEnvVar> getSecretEnvironmentVariablesList()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
-
getSecretEnvironmentVariables
SecretEnvVar getSecretEnvironmentVariables(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
-
getSecretEnvironmentVariablesCount
int getSecretEnvironmentVariablesCount()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
-
getSecretEnvironmentVariablesOrBuilderList
List<? extends SecretEnvVarOrBuilder> getSecretEnvironmentVariablesOrBuilderList()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
-
getSecretEnvironmentVariablesOrBuilder
SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
-
getSecretVolumesList
List<SecretVolume> getSecretVolumesList()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
-
getSecretVolumes
SecretVolume getSecretVolumes(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
-
getSecretVolumesCount
int getSecretVolumesCount()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
-
getSecretVolumesOrBuilderList
List<? extends SecretVolumeOrBuilder> getSecretVolumesOrBuilderList()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
-
getSecretVolumesOrBuilder
SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
-
getSourceToken
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:
- The sourceToken.
-
getSourceTokenBytes
com.google.protobuf.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:
- The bytes for sourceToken.
-
getDockerRepository
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:
- The dockerRepository.
-
getDockerRepositoryBytes
com.google.protobuf.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:
- The bytes for dockerRepository.
-
getDockerRegistryValue
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:
- The enum numeric value on the wire for dockerRegistry.
-
getDockerRegistry
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:
- The dockerRegistry.
-
getSourceCodeCase
CloudFunction.SourceCodeCase getSourceCodeCase()
-
getTriggerCase
CloudFunction.TriggerCase getTriggerCase()
-
-