Package com.google.cloud.functions.v1

Class CloudFunction

  • All Implemented Interfaces:
    CloudFunctionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CloudFunction
extends com.google.protobuf.GeneratedMessageV3
implements CloudFunctionOrBuilder
     Describes a Cloud Function that contains user computation executed in
 response to an event. It encapsulates function and triggers configurations.
    Protobuf type google.cloud.functions.v1.CloudFunction
    See Also:
    Serialized Form

    • Field Detail

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOURCE_ARCHIVE_URL_FIELD_NUMBER

        public static final int SOURCE_ARCHIVE_URL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOURCE_REPOSITORY_FIELD_NUMBER

        public static final int SOURCE_REPOSITORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOURCE_UPLOAD_URL_FIELD_NUMBER

        public static final int SOURCE_UPLOAD_URL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTPS_TRIGGER_FIELD_NUMBER

        public static final int HTTPS_TRIGGER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVENT_TRIGGER_FIELD_NUMBER

        public static final int EVENT_TRIGGER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTRY_POINT_FIELD_NUMBER

        public static final int ENTRY_POINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVAILABLE_MEMORY_MB_FIELD_NUMBER

        public static final int AVAILABLE_MEMORY_MB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERSION_ID_FIELD_NUMBER

        public static final int VERSION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENVIRONMENT_VARIABLES_FIELD_NUMBER

        public static final int ENVIRONMENT_VARIABLES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUILD_ENVIRONMENT_VARIABLES_FIELD_NUMBER

        public static final int BUILD_ENVIRONMENT_VARIABLES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_INSTANCES_FIELD_NUMBER

        public static final int MAX_INSTANCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MIN_INSTANCES_FIELD_NUMBER

        public static final int MIN_INSTANCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VPC_CONNECTOR_FIELD_NUMBER

        public static final int VPC_CONNECTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER

        public static final int VPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INGRESS_SETTINGS_FIELD_NUMBER

        public static final int INGRESS_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KMS_KEY_NAME_FIELD_NUMBER

        public static final int KMS_KEY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUILD_WORKER_POOL_FIELD_NUMBER

        public static final int BUILD_WORKER_POOL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUILD_NAME_FIELD_NUMBER

        public static final int BUILD_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER

        public static final int SECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SECRET_VOLUMES_FIELD_NUMBER

        public static final int SECRET_VOLUMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SOURCE_TOKEN_FIELD_NUMBER

        public static final int SOURCE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCKER_REPOSITORY_FIELD_NUMBER

        public static final int DOCKER_REPOSITORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCKER_REGISTRY_FIELD_NUMBER

        public static final int DOCKER_REGISTRY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`
        string name = 1;
        Specified by:
        getName in interface CloudFunctionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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;
        Specified by:
        getNameBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for name.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         User-provided description of a function.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for description.

      • hasSourceArchiveUrl

        public boolean hasSourceArchiveUrl()
         The Google Cloud Storage URL, starting with `gs://`, pointing to the zip
 archive which contains the function.
        string source_archive_url = 3;
        Specified by:
        hasSourceArchiveUrl in interface CloudFunctionOrBuilder
        Returns:
        Whether the sourceArchiveUrl field is set.

      • getSourceArchiveUrl

        public String getSourceArchiveUrl()
         The Google Cloud Storage URL, starting with `gs://`, pointing to the zip
 archive which contains the function.
        string source_archive_url = 3;
        Specified by:
        getSourceArchiveUrl in interface CloudFunctionOrBuilder
        Returns:
        The sourceArchiveUrl.

      • getSourceArchiveUrlBytes

        public 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;
        Specified by:
        getSourceArchiveUrlBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for sourceArchiveUrl.

      • hasSourceRepository

        public boolean hasSourceRepository()
         **Beta Feature**

 The source repository where a function is hosted.
        .google.cloud.functions.v1.SourceRepository source_repository = 4;
        Specified by:
        hasSourceRepository in interface CloudFunctionOrBuilder
        Returns:
        Whether the sourceRepository field is set.

      • getSourceRepository

        public SourceRepository getSourceRepository()
         **Beta Feature**

 The source repository where a function is hosted.
        .google.cloud.functions.v1.SourceRepository source_repository = 4;
        Specified by:
        getSourceRepository in interface CloudFunctionOrBuilder
        Returns:
        The sourceRepository.

      • hasSourceUploadUrl

        public 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;
        Specified by:
        hasSourceUploadUrl in interface CloudFunctionOrBuilder
        Returns:
        Whether the sourceUploadUrl field is set.

      • getSourceUploadUrl

        public 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;
        Specified by:
        getSourceUploadUrl in interface CloudFunctionOrBuilder
        Returns:
        The sourceUploadUrl.

      • getSourceUploadUrlBytes

        public 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;
        Specified by:
        getSourceUploadUrlBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for sourceUploadUrl.

      • hasHttpsTrigger

        public boolean hasHttpsTrigger()
         An HTTPS endpoint type of source that can be triggered via URL.
        .google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
        Specified by:
        hasHttpsTrigger in interface CloudFunctionOrBuilder
        Returns:
        Whether the httpsTrigger field is set.

      • getHttpsTrigger

        public HttpsTrigger getHttpsTrigger()
         An HTTPS endpoint type of source that can be triggered via URL.
        .google.cloud.functions.v1.HttpsTrigger https_trigger = 5;
        Specified by:
        getHttpsTrigger in interface CloudFunctionOrBuilder
        Returns:
        The httpsTrigger.

      • hasEventTrigger

        public boolean hasEventTrigger()
         A source that fires events in response to a condition in another service.
        .google.cloud.functions.v1.EventTrigger event_trigger = 6;
        Specified by:
        hasEventTrigger in interface CloudFunctionOrBuilder
        Returns:
        Whether the eventTrigger field is set.

      • getEventTrigger

        public EventTrigger getEventTrigger()
         A source that fires events in response to a condition in another service.
        .google.cloud.functions.v1.EventTrigger event_trigger = 6;
        Specified by:
        getEventTrigger in interface CloudFunctionOrBuilder
        Returns:
        The eventTrigger.

      • getStatusValue

        public int getStatusValue()
         Output only. Status of the function deployment.
        .google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface CloudFunctionOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        public CloudFunctionStatus getStatus()
         Output only. Status of the function deployment.
        .google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatus in interface CloudFunctionOrBuilder
        Returns:
        The status.

      • getEntryPoint

        public 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;
        Specified by:
        getEntryPoint in interface CloudFunctionOrBuilder
        Returns:
        The entryPoint.

      • getEntryPointBytes

        public 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;
        Specified by:
        getEntryPointBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for entryPoint.

      • getRuntime

        public 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;
        Specified by:
        getRuntime in interface CloudFunctionOrBuilder
        Returns:
        The runtime.

      • getRuntimeBytes

        public 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;
        Specified by:
        getRuntimeBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for runtime.

      • hasTimeout

        public 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;
        Specified by:
        hasTimeout in interface CloudFunctionOrBuilder
        Returns:
        Whether the timeout field is set.

      • getTimeout

        public 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;
        Specified by:
        getTimeout in interface CloudFunctionOrBuilder
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        public 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;
        Specified by:
        getTimeoutOrBuilder in interface CloudFunctionOrBuilder

      • getAvailableMemoryMb

        public int getAvailableMemoryMb()
         The amount of memory in MB available for a function.
 Defaults to 256MB.
        int32 available_memory_mb = 10;
        Specified by:
        getAvailableMemoryMb in interface CloudFunctionOrBuilder
        Returns:
        The availableMemoryMb.

      • getServiceAccountEmail

        public String getServiceAccountEmail()
         The email of the function's service account. If empty, defaults to
 `{project_id}@appspot.gserviceaccount.com`.
        string service_account_email = 11;
        Specified by:
        getServiceAccountEmail in interface CloudFunctionOrBuilder
        Returns:
        The serviceAccountEmail.

      • getServiceAccountEmailBytes

        public 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;
        Specified by:
        getServiceAccountEmailBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for serviceAccountEmail.

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The last update timestamp of a Cloud Function.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface CloudFunctionOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface CloudFunctionOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        Specified by:
        getUpdateTimeOrBuilder in interface CloudFunctionOrBuilder

      • getVersionId

        public 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];
        Specified by:
        getVersionId in interface CloudFunctionOrBuilder
        Returns:
        The versionId.

      • containsEnvironmentVariables

        public boolean containsEnvironmentVariables​(String key)
         Environment variables that shall be available during function execution.
        map<string, string> environment_variables = 17;
        Specified by:
        containsEnvironmentVariables in interface CloudFunctionOrBuilder

      • containsBuildEnvironmentVariables

        public boolean containsBuildEnvironmentVariables​(String key)
         Build environment variables that shall be available during build time.
        map<string, string> build_environment_variables = 28;
        Specified by:
        containsBuildEnvironmentVariables in interface CloudFunctionOrBuilder

      • getNetwork

        public 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;
        Specified by:
        getNetwork in interface CloudFunctionOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public 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;
        Specified by:
        getNetworkBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for network.

      • getMaxInstances

        public 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;
        Specified by:
        getMaxInstances in interface CloudFunctionOrBuilder
        Returns:
        The maxInstances.

      • getMinInstances

        public int getMinInstances()
         A lower bound for the number function instances that can coexist at a
 given time.
        int32 min_instances = 32;
        Specified by:
        getMinInstances in interface CloudFunctionOrBuilder
        Returns:
        The minInstances.

      • getVpcConnector

        public 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;
        Specified by:
        getVpcConnector in interface CloudFunctionOrBuilder
        Returns:
        The vpcConnector.

      • getVpcConnectorBytes

        public 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;
        Specified by:
        getVpcConnectorBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for vpcConnector.

      • getVpcConnectorEgressSettingsValue

        public 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;
        Specified by:
        getVpcConnectorEgressSettingsValue in interface CloudFunctionOrBuilder
        Returns:
        The enum numeric value on the wire for vpcConnectorEgressSettings.

      • getIngressSettingsValue

        public int getIngressSettingsValue()
         The ingress settings for the function, controlling what traffic can reach
 it.
        .google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;
        Specified by:
        getIngressSettingsValue in interface CloudFunctionOrBuilder
        Returns:
        The enum numeric value on the wire for ingressSettings.

      • getKmsKeyName

        public 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) = { ... }
        Specified by:
        getKmsKeyName in interface CloudFunctionOrBuilder
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        public 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) = { ... }
        Specified by:
        getKmsKeyNameBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • getBuildWorkerPool

        public 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;
        Specified by:
        getBuildWorkerPool in interface CloudFunctionOrBuilder
        Returns:
        The buildWorkerPool.

      • getBuildWorkerPoolBytes

        public 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;
        Specified by:
        getBuildWorkerPoolBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for buildWorkerPool.

      • getBuildId

        public 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];
        Specified by:
        getBuildId in interface CloudFunctionOrBuilder
        Returns:
        The buildId.

      • getBuildIdBytes

        public 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];
        Specified by:
        getBuildIdBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for buildId.

      • getBuildName

        public 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];
        Specified by:
        getBuildName in interface CloudFunctionOrBuilder
        Returns:
        The buildName.

      • getBuildNameBytes

        public 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];
        Specified by:
        getBuildNameBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for buildName.

      • getSecretEnvironmentVariablesCount

        public int getSecretEnvironmentVariablesCount()
         Secret environment variables configuration.
        repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
        Specified by:
        getSecretEnvironmentVariablesCount in interface CloudFunctionOrBuilder

      • getSecretVolumesCount

        public int getSecretVolumesCount()
         Secret volumes configuration.
        repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;
        Specified by:
        getSecretVolumesCount in interface CloudFunctionOrBuilder

      • getSourceToken

        public 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];
        Specified by:
        getSourceToken in interface CloudFunctionOrBuilder
        Returns:
        The sourceToken.

      • getSourceTokenBytes

        public 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];
        Specified by:
        getSourceTokenBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for sourceToken.

      • getDockerRepository

        public 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) = { ... }
        Specified by:
        getDockerRepository in interface CloudFunctionOrBuilder
        Returns:
        The dockerRepository.

      • getDockerRepositoryBytes

        public 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) = { ... }
        Specified by:
        getDockerRepositoryBytes in interface CloudFunctionOrBuilder
        Returns:
        The bytes for dockerRepository.

      • getDockerRegistryValue

        public 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;
        Specified by:
        getDockerRegistryValue in interface CloudFunctionOrBuilder
        Returns:
        The enum numeric value on the wire for dockerRegistry.

      • getDockerRegistry

        public 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;
        Specified by:
        getDockerRegistry in interface CloudFunctionOrBuilder
        Returns:
        The dockerRegistry.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CloudFunction parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudFunction parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudFunction parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudFunction parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudFunction parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudFunction parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudFunction parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public CloudFunction.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CloudFunction.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CloudFunction.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static CloudFunction getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<CloudFunction> parser()

      • getParserForType

        public com.google.protobuf.Parser<CloudFunction> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CloudFunction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder