google_api_cloud_functions v0.6.0 GoogleApi.CloudFunctions.V1.Model.CloudFunction View Source
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. LINT.IfChange
Attributes
- availableMemoryMb (integer()): The amount of memory in MB available for a function.
Defaults to 256MB. Defaults to
nil
. - description (String.t): User-provided description of a function. Defaults to
nil
. - entryPoint (String.t): 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
. Defaults tonil
. - environmentVariables (map()): Environment variables that shall be available during function execution. Defaults to
nil
. - eventTrigger (GoogleApi.CloudFunctions.V1.Model.EventTrigger.t): A source that fires events in response to a condition in another service. Defaults to
nil
. - httpsTrigger (GoogleApi.CloudFunctions.V1.Model.HttpsTrigger.t): An HTTPS endpoint type of source that can be triggered via URL. Defaults to
nil
. - labels (map()): Labels associated with this Cloud Function. Defaults to
nil
. - maxInstances (integer()): The limit on the maximum number of function instances that may coexist at a
given time. Defaults to
nil
. - name (String.t): A user-defined name of the function. Function names must be unique
globally and match pattern
projects/*/locations/*/functions/*
Defaults tonil
. - network (String.t): 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.
This feature is currently in alpha, available only for whitelisted users. Defaults to nil
.
runtime (String.t): Required. The runtime in which the function is going to run. Choices:
nodejs6
: Node.js 6nodejs8
: Node.js 8nodejs10
: Node.js 10python37
: Python 3.7go111
: Go 1.11 Defaults tonil
.serviceAccountEmail (String.t): The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com. Defaults to
nil
.sourceArchiveUrl (String.t): The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. Defaults to
nil
.sourceRepository (GoogleApi.CloudFunctions.V1.Model.SourceRepository.t): Beta Feature
The source repository where a function is hosted. Defaults to nil
.
- sourceUploadUrl (String.t): The Google Cloud Storage signed URL used for source uploading, generated
by google.cloud.functions.v1.GenerateUploadUrl Defaults to
nil
. - status (String.t): Output only. Status of the function deployment. Defaults to
nil
. - timeout (String.t): 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. Defaults to
nil
. - updateTime (DateTime.t): Output only. The last update timestamp of a Cloud Function. Defaults to
nil
. - versionId (String.t): Output only.
The version identifier of the Cloud Function. Each deployment attempt
results in a new version of a function being created. Defaults to
nil
. - vpcConnector (String.t): 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.
This feature is currently in alpha, available only for whitelisted users. Defaults to nil
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Source
t() :: %GoogleApi.CloudFunctions.V1.Model.CloudFunction{
availableMemoryMb: integer(),
description: String.t(),
entryPoint: String.t(),
environmentVariables: map(),
eventTrigger: GoogleApi.CloudFunctions.V1.Model.EventTrigger.t(),
httpsTrigger: GoogleApi.CloudFunctions.V1.Model.HttpsTrigger.t(),
labels: map(),
maxInstances: integer(),
name: String.t(),
network: String.t(),
runtime: String.t(),
serviceAccountEmail: String.t(),
sourceArchiveUrl: String.t(),
sourceRepository: GoogleApi.CloudFunctions.V1.Model.SourceRepository.t(),
sourceUploadUrl: String.t(),
status: String.t(),
timeout: String.t(),
updateTime: DateTime.t(),
versionId: String.t(),
vpcConnector: String.t()
}
t() :: %GoogleApi.CloudFunctions.V1.Model.CloudFunction{ availableMemoryMb: integer(), description: String.t(), entryPoint: String.t(), environmentVariables: map(), eventTrigger: GoogleApi.CloudFunctions.V1.Model.EventTrigger.t(), httpsTrigger: GoogleApi.CloudFunctions.V1.Model.HttpsTrigger.t(), labels: map(), maxInstances: integer(), name: String.t(), network: String.t(), runtime: String.t(), serviceAccountEmail: String.t(), sourceArchiveUrl: String.t(), sourceRepository: GoogleApi.CloudFunctions.V1.Model.SourceRepository.t(), sourceUploadUrl: String.t(), status: String.t(), timeout: String.t(), updateTime: DateTime.t(), versionId: String.t(), vpcConnector: String.t() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.