Package com.google.cloud.functions.v1 (2.43.0)
| GitHub Repository | RPC Documentation | REST Documentation |
This package is not the latest GA version!
For this library, we recommend using the package associated with API version v2 for new applications.
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com.google.cloud.functions.v1.CloudFunctionsServiceClient |
Service Description: A service that application uses to manipulate triggers and functions.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com.google.cloud.functions.v1.CloudFunction.IngressSettings |
Available ingress settings. This controls what traffic can reach the function. |
| com.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings |
Available egress settings. This controls what traffic is diverted through the VPC Access Connector |
| com.google.cloud.functions.v1.CloudFunctionsServiceSettings |
Settings class to configure an instance of CloudFunctionsServiceClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com.google.cloud.functions.v1.CallFunctionRequest |
Request for the CallFunction method.
|
| com.google.cloud.functions.v1.CallFunctionRequest.Builder |
Request for the CallFunction method.
|
| com.google.cloud.functions.v1.CallFunctionResponse |
Response of CallFunction method.
|
| com.google.cloud.functions.v1.CallFunctionResponse.Builder |
Response of CallFunction method.
|
| com.google.cloud.functions.v1.CloudFunction | Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. |
| com.google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy | Security patches are applied automatically to the runtime without requiring the function to be redeployed. |
| com.google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy.Builder | Security patches are applied automatically to the runtime without requiring the function to be redeployed. |
| com.google.cloud.functions.v1.CloudFunction.Builder | Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. |
| com.google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy | Security patches are only applied when a function is redeployed. |
| com.google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy.Builder | Security patches are only applied when a function is redeployed. |
| com.google.cloud.functions.v1.CloudFunctionName | |
| com.google.cloud.functions.v1.CloudFunctionName.Builder | Builder for projects/{project}/locations/{location}/functions/{function}. |
| com.google.cloud.functions.v1.CloudFunctionsServiceClient.ListFunctionsFixedSizeCollection | |
| com.google.cloud.functions.v1.CloudFunctionsServiceClient.ListFunctionsPage | |
| com.google.cloud.functions.v1.CloudFunctionsServiceClient.ListFunctionsPagedResponse | |
| com.google.cloud.functions.v1.CloudFunctionsServiceClient.ListLocationsFixedSizeCollection | |
| com.google.cloud.functions.v1.CloudFunctionsServiceClient.ListLocationsPage | |
| com.google.cloud.functions.v1.CloudFunctionsServiceClient.ListLocationsPagedResponse | |
| com.google.cloud.functions.v1.CloudFunctionsServiceGrpc | A service that application uses to manipulate triggers and functions. |
| com.google.cloud.functions.v1.CloudFunctionsServiceGrpc.CloudFunctionsServiceImplBase | Base class for the server implementation of the service CloudFunctionsService. A service that application uses to manipulate triggers and functions. |
| com.google.cloud.functions.v1.CloudFunctionsServiceSettings.Builder | Builder for CloudFunctionsServiceSettings. |
| com.google.cloud.functions.v1.CreateFunctionRequest |
Request for the CreateFunction method.
|
| com.google.cloud.functions.v1.CreateFunctionRequest.Builder |
Request for the CreateFunction method.
|
| com.google.cloud.functions.v1.CryptoKeyName | |
| com.google.cloud.functions.v1.CryptoKeyName.Builder | Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. |
| com.google.cloud.functions.v1.DeleteFunctionRequest |
Request for the DeleteFunction method.
|
| com.google.cloud.functions.v1.DeleteFunctionRequest.Builder |
Request for the DeleteFunction method.
|
| com.google.cloud.functions.v1.EventTrigger | Describes EventTrigger, used to request events be sent from another service. |
| com.google.cloud.functions.v1.EventTrigger.Builder | Describes EventTrigger, used to request events be sent from another service. |
| com.google.cloud.functions.v1.FailurePolicy | Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). |
| com.google.cloud.functions.v1.FailurePolicy.Builder | Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them). |
| com.google.cloud.functions.v1.FailurePolicy.Retry | Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff |
| com.google.cloud.functions.v1.FailurePolicy.Retry.Builder | Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff |
| com.google.cloud.functions.v1.FunctionsOperationsProto | |
| com.google.cloud.functions.v1.FunctionsProto | |
| com.google.cloud.functions.v1.GenerateDownloadUrlRequest |
Request of GenerateDownloadUrl method.
|
| com.google.cloud.functions.v1.GenerateDownloadUrlRequest.Builder |
Request of GenerateDownloadUrl method.
|
| com.google.cloud.functions.v1.GenerateDownloadUrlResponse |
Response of GenerateDownloadUrl method.
|
| com.google.cloud.functions.v1.GenerateDownloadUrlResponse.Builder |
Response of GenerateDownloadUrl method.
|
| com.google.cloud.functions.v1.GenerateUploadUrlRequest |
Request of GenerateSourceUploadUrl method.
|
| com.google.cloud.functions.v1.GenerateUploadUrlRequest.Builder |
Request of GenerateSourceUploadUrl method.
|
| com.google.cloud.functions.v1.GenerateUploadUrlResponse |
Response of GenerateSourceUploadUrl method.
|
| com.google.cloud.functions.v1.GenerateUploadUrlResponse.Builder |
Response of GenerateSourceUploadUrl method.
|
| com.google.cloud.functions.v1.GetFunctionRequest |
Request for the GetFunction method.
|
| com.google.cloud.functions.v1.GetFunctionRequest.Builder |
Request for the GetFunction method.
|
| com.google.cloud.functions.v1.HttpsTrigger | Describes HttpsTrigger, could be used to connect web hooks to function. |
| com.google.cloud.functions.v1.HttpsTrigger.Builder | Describes HttpsTrigger, could be used to connect web hooks to function. |
| com.google.cloud.functions.v1.ListFunctionsRequest |
Request for the ListFunctions method.
|
| com.google.cloud.functions.v1.ListFunctionsRequest.Builder |
Request for the ListFunctions method.
|
| com.google.cloud.functions.v1.ListFunctionsResponse |
Response for the ListFunctions method.
|
| com.google.cloud.functions.v1.ListFunctionsResponse.Builder |
Response for the ListFunctions method.
|
| com.google.cloud.functions.v1.LocationName | |
| com.google.cloud.functions.v1.LocationName.Builder | Builder for projects/{project}/locations/{location}. |
| com.google.cloud.functions.v1.OperationMetadataV1 | Metadata describing an Operation |
| com.google.cloud.functions.v1.OperationMetadataV1.Builder | Metadata describing an Operation |
| com.google.cloud.functions.v1.SecretEnvVar | Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable. |
| com.google.cloud.functions.v1.SecretEnvVar.Builder | Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable. |
| com.google.cloud.functions.v1.SecretVolume | Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not |
| com.google.cloud.functions.v1.SecretVolume.Builder | Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not |
| com.google.cloud.functions.v1.SecretVolume.SecretVersion | Configuration for a single version. |
| com.google.cloud.functions.v1.SecretVolume.SecretVersion.Builder | Configuration for a single version. |
| com.google.cloud.functions.v1.SourceRepository | Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. |
| com.google.cloud.functions.v1.SourceRepository.Builder | Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. |
| com.google.cloud.functions.v1.UpdateFunctionRequest |
Request for the UpdateFunction method.
|
| com.google.cloud.functions.v1.UpdateFunctionRequest.Builder |
Request for the UpdateFunction method.
|
Interfaces
Enums
| Enum | Description |
|---|---|
| com.google.cloud.functions.v1.CloudFunction.DockerRegistry | Docker Registry to use for storing function Docker images. |
| com.google.cloud.functions.v1.CloudFunction.RuntimeUpdatePolicyCase | |
| com.google.cloud.functions.v1.CloudFunction.SourceCodeCase | |
| com.google.cloud.functions.v1.CloudFunction.TriggerCase | |
| com.google.cloud.functions.v1.CloudFunctionStatus | Describes the current stage of a deployment. |
| com.google.cloud.functions.v1.FailurePolicy.ActionCase | |
| com.google.cloud.functions.v1.HttpsTrigger.SecurityLevel | Available security level settings. This controls the methods to enforce security (HTTPS) on a URL. |
| com.google.cloud.functions.v1.OperationType | A type of an operation. |