Package com.google.cloud.functions.v2alpha (2.89.0)

2.89.0 (latest) 2.87.0 2.85.0 2.84.0 2.83.0 2.82.0 2.80.0 2.78.0 2.77.0 2.76.0 2.75.0 2.74.0 2.72.0 2.70.0 2.69.0 2.66.0 2.65.0 2.64.0 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.51.0 2.50.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.4 2.4.3 2.3.6

GitHub Repository

RPC Documentation

REST Documentation

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.functions.v2 for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution.

Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.

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.v2alpha.FunctionServiceClient	Service Description: Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings	Description
com.google.cloud.functions.v2alpha.FunctionServiceSettings	Settings class to configure an instance of FunctionServiceClient. The default instance has everything set to sensible defaults:
com.google.cloud.functions.v2alpha.ServiceConfig.IngressSettings	Available ingress settings. This controls what traffic can reach the function.
com.google.cloud.functions.v2alpha.ServiceConfig.VpcConnectorEgressSettings	Available egress settings. This controls what traffic is diverted through the VPC Access Connector

Classes

Class	Description
com.google.cloud.functions.v2alpha.AutomaticUpdatePolicy	Security patches are applied automatically to the runtime without requiring the function to be redeployed.
com.google.cloud.functions.v2alpha.AutomaticUpdatePolicy.Builder	Security patches are applied automatically to the runtime without requiring the function to be redeployed.
com.google.cloud.functions.v2alpha.BuildConfig	Describes the Build step of the function that builds a container from the given source.
com.google.cloud.functions.v2alpha.BuildConfig.Builder	Describes the Build step of the function that builds a container from the given source.
com.google.cloud.functions.v2alpha.CreateFunctionRequest	Request for the CreateFunction method.
com.google.cloud.functions.v2alpha.CreateFunctionRequest.Builder	Request for the CreateFunction method.
com.google.cloud.functions.v2alpha.CryptoKeyName
com.google.cloud.functions.v2alpha.CryptoKeyName.Builder	Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
com.google.cloud.functions.v2alpha.DeleteFunctionRequest	Request for the DeleteFunction method.
com.google.cloud.functions.v2alpha.DeleteFunctionRequest.Builder	Request for the DeleteFunction method.
com.google.cloud.functions.v2alpha.EventFilter	Filters events based on exact matches on the CloudEvents attributes.
com.google.cloud.functions.v2alpha.EventFilter.Builder	Filters events based on exact matches on the CloudEvents attributes.
com.google.cloud.functions.v2alpha.EventTrigger	Describes EventTrigger, used to request events to be sent from another service.
com.google.cloud.functions.v2alpha.EventTrigger.Builder	Describes EventTrigger, used to request events to be sent from another service.
com.google.cloud.functions.v2alpha.Function	Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
com.google.cloud.functions.v2alpha.Function.Builder	Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
com.google.cloud.functions.v2alpha.FunctionName
com.google.cloud.functions.v2alpha.FunctionName.Builder	Builder for projects/{project}/locations/{location}/functions/{function}.
com.google.cloud.functions.v2alpha.FunctionServiceClient.ListFunctionsFixedSizeCollection
com.google.cloud.functions.v2alpha.FunctionServiceClient.ListFunctionsPage
com.google.cloud.functions.v2alpha.FunctionServiceClient.ListFunctionsPagedResponse
com.google.cloud.functions.v2alpha.FunctionServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.functions.v2alpha.FunctionServiceClient.ListLocationsPage
com.google.cloud.functions.v2alpha.FunctionServiceClient.ListLocationsPagedResponse
com.google.cloud.functions.v2alpha.FunctionServiceGrpc	Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.
com.google.cloud.functions.v2alpha.FunctionServiceGrpc.FunctionServiceImplBase	Base class for the server implementation of the service FunctionService. Google Cloud Functions is used to deploy functions that are executed by
com.google.cloud.functions.v2alpha.FunctionServiceSettings.Builder	Builder for FunctionServiceSettings.
com.google.cloud.functions.v2alpha.FunctionsProto
com.google.cloud.functions.v2alpha.GenerateDownloadUrlRequest	Request of GenerateDownloadUrl method.
com.google.cloud.functions.v2alpha.GenerateDownloadUrlRequest.Builder	Request of GenerateDownloadUrl method.
com.google.cloud.functions.v2alpha.GenerateDownloadUrlResponse	Response of GenerateDownloadUrl method.
com.google.cloud.functions.v2alpha.GenerateDownloadUrlResponse.Builder	Response of GenerateDownloadUrl method.
com.google.cloud.functions.v2alpha.GenerateUploadUrlRequest	Request of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2alpha.GenerateUploadUrlRequest.Builder	Request of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2alpha.GenerateUploadUrlResponse	Response of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2alpha.GenerateUploadUrlResponse.Builder	Response of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2alpha.GetFunctionRequest	Request for the GetFunction method.
com.google.cloud.functions.v2alpha.GetFunctionRequest.Builder	Request for the GetFunction method.
com.google.cloud.functions.v2alpha.ListFunctionsRequest	Request for the ListFunctions method.
com.google.cloud.functions.v2alpha.ListFunctionsRequest.Builder	Request for the ListFunctions method.
com.google.cloud.functions.v2alpha.ListFunctionsResponse	Response for the ListFunctions method.
com.google.cloud.functions.v2alpha.ListFunctionsResponse.Builder	Response for the ListFunctions method.
com.google.cloud.functions.v2alpha.ListRuntimesRequest	Request for the ListRuntimes method.
com.google.cloud.functions.v2alpha.ListRuntimesRequest.Builder	Request for the ListRuntimes method.
com.google.cloud.functions.v2alpha.ListRuntimesResponse	Response for the ListRuntimes method.
com.google.cloud.functions.v2alpha.ListRuntimesResponse.Builder	Response for the ListRuntimes method.
com.google.cloud.functions.v2alpha.ListRuntimesResponse.Runtime	Describes a runtime and any special information (e.g., deprecation status) related to it.
com.google.cloud.functions.v2alpha.ListRuntimesResponse.Runtime.Builder	Describes a runtime and any special information (e.g., deprecation status) related to it.
com.google.cloud.functions.v2alpha.LocationMetadata	Extra GCF specific location information.
com.google.cloud.functions.v2alpha.LocationMetadata.Builder	Extra GCF specific location information.
com.google.cloud.functions.v2alpha.LocationName
com.google.cloud.functions.v2alpha.LocationName.Builder	Builder for projects/{project}/locations/{location}.
com.google.cloud.functions.v2alpha.OnDeployUpdatePolicy	Security patches are only applied when a function is redeployed.
com.google.cloud.functions.v2alpha.OnDeployUpdatePolicy.Builder	Security patches are only applied when a function is redeployed.
com.google.cloud.functions.v2alpha.OperationMetadata	Represents the metadata of the long-running operation.
com.google.cloud.functions.v2alpha.OperationMetadata.Builder	Represents the metadata of the long-running operation.
com.google.cloud.functions.v2alpha.RepoSource	Location of the source in a Google Cloud Source Repository.
com.google.cloud.functions.v2alpha.RepoSource.Builder	Location of the source in a Google Cloud Source Repository.
com.google.cloud.functions.v2alpha.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.v2alpha.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.v2alpha.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.
com.google.cloud.functions.v2alpha.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.
com.google.cloud.functions.v2alpha.SecretVolume.SecretVersion	Configuration for a single version.
com.google.cloud.functions.v2alpha.SecretVolume.SecretVersion.Builder	Configuration for a single version.
com.google.cloud.functions.v2alpha.ServiceConfig	Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
com.google.cloud.functions.v2alpha.ServiceConfig.Builder	Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
com.google.cloud.functions.v2alpha.Source	The location of the function source code.
com.google.cloud.functions.v2alpha.Source.Builder	The location of the function source code.
com.google.cloud.functions.v2alpha.SourceProvenance	Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
com.google.cloud.functions.v2alpha.SourceProvenance.Builder	Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
com.google.cloud.functions.v2alpha.Stage	Each Stage of the deployment process
com.google.cloud.functions.v2alpha.Stage.Builder	Each Stage of the deployment process
com.google.cloud.functions.v2alpha.StateMessage	Informational messages about the state of the Cloud Function or Operation.
com.google.cloud.functions.v2alpha.StateMessage.Builder	Informational messages about the state of the Cloud Function or Operation.
com.google.cloud.functions.v2alpha.StorageSource	Location of the source in an archive file in Google Cloud Storage.
com.google.cloud.functions.v2alpha.StorageSource.Builder	Location of the source in an archive file in Google Cloud Storage.
com.google.cloud.functions.v2alpha.UpdateFunctionRequest	Request for the UpdateFunction method.
com.google.cloud.functions.v2alpha.UpdateFunctionRequest.Builder	Request for the UpdateFunction method.

Interfaces

Interface	Description
com.google.cloud.functions.v2alpha.AutomaticUpdatePolicyOrBuilder
com.google.cloud.functions.v2alpha.BuildConfigOrBuilder
com.google.cloud.functions.v2alpha.CreateFunctionRequestOrBuilder
com.google.cloud.functions.v2alpha.DeleteFunctionRequestOrBuilder
com.google.cloud.functions.v2alpha.EventFilterOrBuilder
com.google.cloud.functions.v2alpha.EventTriggerOrBuilder
com.google.cloud.functions.v2alpha.FunctionOrBuilder
com.google.cloud.functions.v2alpha.FunctionServiceGrpc.AsyncService	Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.
com.google.cloud.functions.v2alpha.GenerateDownloadUrlRequestOrBuilder
com.google.cloud.functions.v2alpha.GenerateDownloadUrlResponseOrBuilder
com.google.cloud.functions.v2alpha.GenerateUploadUrlRequestOrBuilder
com.google.cloud.functions.v2alpha.GenerateUploadUrlResponseOrBuilder
com.google.cloud.functions.v2alpha.GetFunctionRequestOrBuilder
com.google.cloud.functions.v2alpha.ListFunctionsRequestOrBuilder
com.google.cloud.functions.v2alpha.ListFunctionsResponseOrBuilder
com.google.cloud.functions.v2alpha.ListRuntimesRequestOrBuilder
com.google.cloud.functions.v2alpha.ListRuntimesResponse.RuntimeOrBuilder
com.google.cloud.functions.v2alpha.ListRuntimesResponseOrBuilder
com.google.cloud.functions.v2alpha.LocationMetadataOrBuilder
com.google.cloud.functions.v2alpha.OnDeployUpdatePolicyOrBuilder
com.google.cloud.functions.v2alpha.OperationMetadataOrBuilder
com.google.cloud.functions.v2alpha.RepoSourceOrBuilder
com.google.cloud.functions.v2alpha.SecretEnvVarOrBuilder
com.google.cloud.functions.v2alpha.SecretVolume.SecretVersionOrBuilder
com.google.cloud.functions.v2alpha.SecretVolumeOrBuilder
com.google.cloud.functions.v2alpha.ServiceConfigOrBuilder
com.google.cloud.functions.v2alpha.SourceOrBuilder
com.google.cloud.functions.v2alpha.SourceProvenanceOrBuilder
com.google.cloud.functions.v2alpha.StageOrBuilder
com.google.cloud.functions.v2alpha.StateMessageOrBuilder
com.google.cloud.functions.v2alpha.StorageSourceOrBuilder
com.google.cloud.functions.v2alpha.UpdateFunctionRequestOrBuilder

Enums

Enum	Description
com.google.cloud.functions.v2alpha.BuildConfig.DockerRegistry	Docker Registry to use for storing function Docker images.
com.google.cloud.functions.v2alpha.BuildConfig.RuntimeUpdatePolicyCase
com.google.cloud.functions.v2alpha.Environment	The environment the function is hosted on.
com.google.cloud.functions.v2alpha.EventTrigger.RetryPolicy	Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.
com.google.cloud.functions.v2alpha.Function.State	Describes the current state of the function.
com.google.cloud.functions.v2alpha.ListRuntimesResponse.RuntimeStage	The various stages that a runtime can be in.
com.google.cloud.functions.v2alpha.OperationType	The type of the long running operation.
com.google.cloud.functions.v2alpha.RepoSource.RevisionCase
com.google.cloud.functions.v2alpha.ServiceConfig.SecurityLevel	Available security level settings. This enforces security protocol on function URL.
com.google.cloud.functions.v2alpha.Source.SourceCase
com.google.cloud.functions.v2alpha.Stage.Name	Possible names for a Stage
com.google.cloud.functions.v2alpha.Stage.State	Possible states for a Stage
com.google.cloud.functions.v2alpha.StateMessage.Severity	Severity of the state message.