Package com.google.cloud.functions.v2 (2.37.0)

GitHub RepositoryRPC DocumentationREST Documentation

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.v2.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.v2.FunctionServiceSettings Settings class to configure an instance of FunctionServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.functions.v2.ServiceConfig.IngressSettings

Available ingress settings.

This controls what traffic can reach the function.

com.google.cloud.functions.v2.ServiceConfig.VpcConnectorEgressSettings

Available egress settings.

This controls what traffic is diverted through the VPC Access Connector

Classes

Class Description
com.google.cloud.functions.v2.BuildConfig Describes the Build step of the function that builds a container from the given source.
com.google.cloud.functions.v2.BuildConfig.Builder Describes the Build step of the function that builds a container from the given source.
com.google.cloud.functions.v2.CreateFunctionRequest Request for the CreateFunction method.
com.google.cloud.functions.v2.CreateFunctionRequest.Builder Request for the CreateFunction method.
com.google.cloud.functions.v2.CryptoKeyName
com.google.cloud.functions.v2.CryptoKeyName.Builder Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
com.google.cloud.functions.v2.DeleteFunctionRequest Request for the DeleteFunction method.
com.google.cloud.functions.v2.DeleteFunctionRequest.Builder Request for the DeleteFunction method.
com.google.cloud.functions.v2.EventFilter Filters events based on exact matches on the CloudEvents attributes.
com.google.cloud.functions.v2.EventFilter.Builder Filters events based on exact matches on the CloudEvents attributes.
com.google.cloud.functions.v2.EventTrigger Describes EventTrigger, used to request events to be sent from another service.
com.google.cloud.functions.v2.EventTrigger.Builder Describes EventTrigger, used to request events to be sent from another service.
com.google.cloud.functions.v2.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.v2.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.v2.FunctionName
com.google.cloud.functions.v2.FunctionName.Builder Builder for projects/{project}/locations/{location}/functions/{function}.
com.google.cloud.functions.v2.FunctionServiceClient.ListFunctionsFixedSizeCollection
com.google.cloud.functions.v2.FunctionServiceClient.ListFunctionsPage
com.google.cloud.functions.v2.FunctionServiceClient.ListFunctionsPagedResponse
com.google.cloud.functions.v2.FunctionServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.functions.v2.FunctionServiceClient.ListLocationsPage
com.google.cloud.functions.v2.FunctionServiceClient.ListLocationsPagedResponse
com.google.cloud.functions.v2.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.v2.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.v2.FunctionServiceSettings.Builder Builder for FunctionServiceSettings.
com.google.cloud.functions.v2.FunctionsProto
com.google.cloud.functions.v2.GenerateDownloadUrlRequest Request of GenerateDownloadUrl method.
com.google.cloud.functions.v2.GenerateDownloadUrlRequest.Builder Request of GenerateDownloadUrl method.
com.google.cloud.functions.v2.GenerateDownloadUrlResponse Response of GenerateDownloadUrl method.
com.google.cloud.functions.v2.GenerateDownloadUrlResponse.Builder Response of GenerateDownloadUrl method.
com.google.cloud.functions.v2.GenerateUploadUrlRequest Request of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2.GenerateUploadUrlRequest.Builder Request of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2.GenerateUploadUrlResponse Response of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2.GenerateUploadUrlResponse.Builder Response of GenerateSourceUploadUrl method.
com.google.cloud.functions.v2.GetFunctionRequest Request for the GetFunction method.
com.google.cloud.functions.v2.GetFunctionRequest.Builder Request for the GetFunction method.
com.google.cloud.functions.v2.ListFunctionsRequest Request for the ListFunctions method.
com.google.cloud.functions.v2.ListFunctionsRequest.Builder Request for the ListFunctions method.
com.google.cloud.functions.v2.ListFunctionsResponse Response for the ListFunctions method.
com.google.cloud.functions.v2.ListFunctionsResponse.Builder Response for the ListFunctions method.
com.google.cloud.functions.v2.ListRuntimesRequest Request for the ListRuntimes method.
com.google.cloud.functions.v2.ListRuntimesRequest.Builder Request for the ListRuntimes method.
com.google.cloud.functions.v2.ListRuntimesResponse Response for the ListRuntimes method.
com.google.cloud.functions.v2.ListRuntimesResponse.Builder Response for the ListRuntimes method.
com.google.cloud.functions.v2.ListRuntimesResponse.Runtime Describes a runtime and any special information (e.g., deprecation status) related to it.
com.google.cloud.functions.v2.ListRuntimesResponse.Runtime.Builder Describes a runtime and any special information (e.g., deprecation status) related to it.
com.google.cloud.functions.v2.LocationMetadata Extra GCF specific location information.
com.google.cloud.functions.v2.LocationMetadata.Builder Extra GCF specific location information.
com.google.cloud.functions.v2.LocationName
com.google.cloud.functions.v2.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.functions.v2.OperationMetadata Represents the metadata of the long-running operation.
com.google.cloud.functions.v2.OperationMetadata.Builder Represents the metadata of the long-running operation.
com.google.cloud.functions.v2.RepoSource Location of the source in a Google Cloud Source Repository.
com.google.cloud.functions.v2.RepoSource.Builder Location of the source in a Google Cloud Source Repository.
com.google.cloud.functions.v2.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.v2.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.v2.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.v2.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.v2.SecretVolume.SecretVersion Configuration for a single version.
com.google.cloud.functions.v2.SecretVolume.SecretVersion.Builder Configuration for a single version.
com.google.cloud.functions.v2.ServiceConfig Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
com.google.cloud.functions.v2.ServiceConfig.Builder Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
com.google.cloud.functions.v2.Source The location of the function source code.
com.google.cloud.functions.v2.Source.Builder The location of the function source code.
com.google.cloud.functions.v2.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.v2.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.v2.Stage Each Stage of the deployment process
com.google.cloud.functions.v2.Stage.Builder Each Stage of the deployment process
com.google.cloud.functions.v2.StateMessage Informational messages about the state of the Cloud Function or Operation.
com.google.cloud.functions.v2.StateMessage.Builder Informational messages about the state of the Cloud Function or Operation.
com.google.cloud.functions.v2.StorageSource Location of the source in an archive file in Google Cloud Storage.
com.google.cloud.functions.v2.StorageSource.Builder Location of the source in an archive file in Google Cloud Storage.
com.google.cloud.functions.v2.UpdateFunctionRequest Request for the UpdateFunction method.
com.google.cloud.functions.v2.UpdateFunctionRequest.Builder Request for the UpdateFunction method.

Interfaces

Interface Description
com.google.cloud.functions.v2.BuildConfigOrBuilder
com.google.cloud.functions.v2.CreateFunctionRequestOrBuilder
com.google.cloud.functions.v2.DeleteFunctionRequestOrBuilder
com.google.cloud.functions.v2.EventFilterOrBuilder
com.google.cloud.functions.v2.EventTriggerOrBuilder
com.google.cloud.functions.v2.FunctionOrBuilder
com.google.cloud.functions.v2.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.v2.GenerateDownloadUrlRequestOrBuilder
com.google.cloud.functions.v2.GenerateDownloadUrlResponseOrBuilder
com.google.cloud.functions.v2.GenerateUploadUrlRequestOrBuilder
com.google.cloud.functions.v2.GenerateUploadUrlResponseOrBuilder
com.google.cloud.functions.v2.GetFunctionRequestOrBuilder
com.google.cloud.functions.v2.ListFunctionsRequestOrBuilder
com.google.cloud.functions.v2.ListFunctionsResponseOrBuilder
com.google.cloud.functions.v2.ListRuntimesRequestOrBuilder
com.google.cloud.functions.v2.ListRuntimesResponse.RuntimeOrBuilder
com.google.cloud.functions.v2.ListRuntimesResponseOrBuilder
com.google.cloud.functions.v2.LocationMetadataOrBuilder
com.google.cloud.functions.v2.OperationMetadataOrBuilder
com.google.cloud.functions.v2.RepoSourceOrBuilder
com.google.cloud.functions.v2.SecretEnvVarOrBuilder
com.google.cloud.functions.v2.SecretVolume.SecretVersionOrBuilder
com.google.cloud.functions.v2.SecretVolumeOrBuilder
com.google.cloud.functions.v2.ServiceConfigOrBuilder
com.google.cloud.functions.v2.SourceOrBuilder
com.google.cloud.functions.v2.SourceProvenanceOrBuilder
com.google.cloud.functions.v2.StageOrBuilder
com.google.cloud.functions.v2.StateMessageOrBuilder
com.google.cloud.functions.v2.StorageSourceOrBuilder
com.google.cloud.functions.v2.UpdateFunctionRequestOrBuilder

Enums

Enum Description
com.google.cloud.functions.v2.BuildConfig.DockerRegistry Docker Registry to use for storing function Docker images.
com.google.cloud.functions.v2.Environment The environment the function is hosted on.
com.google.cloud.functions.v2.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.v2.Function.State Describes the current state of the function.
com.google.cloud.functions.v2.ListRuntimesResponse.RuntimeStage The various stages that a runtime can be in.
com.google.cloud.functions.v2.RepoSource.RevisionCase
com.google.cloud.functions.v2.ServiceConfig.SecurityLevel Available security level settings. This enforces security protocol on function URL.
com.google.cloud.functions.v2.Source.SourceCase
com.google.cloud.functions.v2.Stage.Name Possible names for a Stage
com.google.cloud.functions.v2.Stage.State Possible states for a Stage
com.google.cloud.functions.v2.StateMessage.Severity Severity of the state message.