public sealed class CloudFunction : IMessage<CloudFunction>, IEquatable<CloudFunction>, IDeepCloneable<CloudFunction>, IBufferMessage, IMessageDescribes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.
Implements
IMessage<CloudFunction>, IEquatable<CloudFunction>, IDeepCloneable<CloudFunction>, IBufferMessage, IMessageNamespace
Google.Cloud.Functions.V1Assembly
Google.Cloud.Functions.V1.dll
Constructors
CloudFunction()
public CloudFunction()CloudFunction(CloudFunction)
public CloudFunction(CloudFunction other)| Parameter | |
|---|---|
| Name | Description |
other | CloudFunction |
Properties
AvailableMemoryMb
public int AvailableMemoryMb { get; set; }The amount of memory in MB available for a function. Defaults to 256MB.
| Property Value | |
|---|---|
| Type | Description |
Int32 | |
BuildId
public string BuildId { get; set; }Output only. The Cloud Build ID of the latest successful deployment of the function.
| Property Value | |
|---|---|
| Type | Description |
String | |
CloudFunctionName
public CloudFunctionName CloudFunctionName { get; set; }CloudFunctionName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
CloudFunctionName | |
Description
public string Description { get; set; }User-provided description of a function.
| Property Value | |
|---|---|
| Type | Description |
String | |
EntryPoint
public string EntryPoint { get; set; }The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
| Property Value | |
|---|---|
| Type | Description |
String | |
EnvironmentVariables
public MapField<string, string> EnvironmentVariables { get; }Environment variables that shall be available during function execution.
| Property Value | |
|---|---|
| Type | Description |
MapField<String, String> | |
EventTrigger
public EventTrigger EventTrigger { get; set; }A source that fires events in response to a condition in another service.
| Property Value | |
|---|---|
| Type | Description |
EventTrigger | |
HttpsTrigger
public HttpsTrigger HttpsTrigger { get; set; }An HTTPS endpoint type of source that can be triggered via URL.
| Property Value | |
|---|---|
| Type | Description |
HttpsTrigger | |
IngressSettings
public CloudFunction.Types.IngressSettings IngressSettings { get; set; }The ingress settings for the function, controlling what traffic can reach it.
| Property Value | |
|---|---|
| Type | Description |
CloudFunction.Types.IngressSettings | |
Labels
public MapField<string, string> Labels { get; }Labels associated with this Cloud Function.
| Property Value | |
|---|---|
| Type | Description |
MapField<String, String> | |
MaxInstances
public int MaxInstances { get; set; }The limit on the maximum number of function instances that may coexist at a given time.
| Property Value | |
|---|---|
| Type | Description |
Int32 | |
Name
public string Name { get; set; }A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
| Property Value | |
|---|---|
| Type | Description |
String | |
Network
public string Network { get; set; }The VPC Network that this cloud function can connect to. It can be
either the fully-qualified URI, or the short name of the network resource.
If the short network name is used, the network must belong to the same
project. 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 for more information on connecting Cloud projects.
| Property Value | |
|---|---|
| Type | Description |
String | |
Runtime
public string Runtime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
String | |
ServiceAccountEmail
public string ServiceAccountEmail { get; set; }The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com.
| Property Value | |
|---|---|
| Type | Description |
String | |
SourceArchiveUrl
public string SourceArchiveUrl { get; set; }The Google Cloud Storage URL, starting with gs://, pointing to the zip
archive which contains the function.
| Property Value | |
|---|---|
| Type | Description |
String | |
SourceCodeCase
public CloudFunction.SourceCodeOneofCase SourceCodeCase { get; }| Property Value | |
|---|---|
| Type | Description |
CloudFunction.SourceCodeOneofCase | |
SourceRepository
public SourceRepository SourceRepository { get; set; }Beta Feature
The source repository where a function is hosted.
| Property Value | |
|---|---|
| Type | Description |
SourceRepository | |
SourceUploadUrl
public string SourceUploadUrl { get; set; }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)
| Property Value | |
|---|---|
| Type | Description |
String | |
Status
public CloudFunctionStatus Status { get; set; }Output only. Status of the function deployment.
| Property Value | |
|---|---|
| Type | Description |
CloudFunctionStatus | |
Timeout
public Duration Timeout { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |
TriggerCase
public CloudFunction.TriggerOneofCase TriggerCase { get; }| Property Value | |
|---|---|
| Type | Description |
CloudFunction.TriggerOneofCase | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The last update timestamp of a Cloud Function.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
VersionId
public long VersionId { get; set; }Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
| Property Value | |
|---|---|
| Type | Description |
Int64 | |
VpcConnector
public string VpcConnector { get; set; }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 for more information on connecting Cloud projects.
| Property Value | |
|---|---|
| Type | Description |
String | |
VpcConnectorEgressSettings
public CloudFunction.Types.VpcConnectorEgressSettings VpcConnectorEgressSettings { get; set; }The egress settings for the connector, controlling what traffic is diverted through it.
| Property Value | |
|---|---|
| Type | Description |
CloudFunction.Types.VpcConnectorEgressSettings | |