GoogleApi.CloudFunctions.V1.Model.CloudFunction (google_api_cloud_functions v0.32.1) View Source

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. Next tag: 35

Attributes

  • availableMemoryMb (type: integer(), default: nil) - The amount of memory in MB available for a function. Defaults to 256MB.
  • buildEnvironmentVariables (type: map(), default: nil) - Build environment variables that shall be available during build time.
  • buildId (type: String.t, default: nil) - Output only. The Cloud Build ID of the latest successful deployment of the function.
  • buildWorkerPool (type: String.t, default: nil) - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
  • description (type: String.t, default: nil) - User-provided description of a function.
  • entryPoint (type: String.t, default: nil) - 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.
  • environmentVariables (type: map(), default: nil) - Environment variables that shall be available during function execution.
  • eventTrigger (type: GoogleApi.CloudFunctions.V1.Model.EventTrigger.t, default: nil) - A source that fires events in response to a condition in another service.
  • httpsTrigger (type: GoogleApi.CloudFunctions.V1.Model.HttpsTrigger.t, default: nil) - An HTTPS endpoint type of source that can be triggered via URL.
  • ingressSettings (type: String.t, default: nil) - The ingress settings for the function, controlling what traffic can reach it.
  • labels (type: map(), default: nil) - Labels associated with this Cloud Function.
  • maxInstances (type: integer(), default: nil) - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
  • name (type: String.t, default: nil) - A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
  • network (type: String.t, default: nil) - 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.
  • runtime (type: String.t, default: nil) - 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.
  • secretEnvironmentVariables (type: list(GoogleApi.CloudFunctions.V1.Model.SecretEnvVar.t), default: nil) - Secret environment variables configuration.
  • secretVolumes (type: list(GoogleApi.CloudFunctions.V1.Model.SecretVolume.t), default: nil) - Secret volumes configuration.
  • serviceAccountEmail (type: String.t, default: nil) - The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.
  • sourceArchiveUrl (type: String.t, default: nil) - The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
  • sourceRepository (type: GoogleApi.CloudFunctions.V1.Model.SourceRepository.t, default: nil) - Beta Feature The source repository where a function is hosted.
  • sourceToken (type: String.t, default: nil) - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
  • sourceUploadUrl (type: String.t, default: nil) - The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl
  • status (type: String.t, default: nil) - Output only. Status of the function deployment.
  • timeout (type: String.t, default: nil) - 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.
  • updateTime (type: DateTime.t, default: nil) - Output only. The last update timestamp of a Cloud Function.
  • versionId (type: String.t, default: nil) - Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
  • vpcConnector (type: String.t, default: nil) - 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.
  • vpcConnectorEgressSettings (type: String.t, default: nil) - The egress settings for the connector, controlling what traffic is diverted through it.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.CloudFunctions.V1.Model.CloudFunction{
  availableMemoryMb: integer() | nil,
  buildEnvironmentVariables: map() | nil,
  buildId: String.t() | nil,
  buildWorkerPool: String.t() | nil,
  description: String.t() | nil,
  entryPoint: String.t() | nil,
  environmentVariables: map() | nil,
  eventTrigger: GoogleApi.CloudFunctions.V1.Model.EventTrigger.t() | nil,
  httpsTrigger: GoogleApi.CloudFunctions.V1.Model.HttpsTrigger.t() | nil,
  ingressSettings: String.t() | nil,
  labels: map() | nil,
  maxInstances: integer() | nil,
  name: String.t() | nil,
  network: String.t() | nil,
  runtime: String.t() | nil,
  secretEnvironmentVariables:
    [GoogleApi.CloudFunctions.V1.Model.SecretEnvVar.t()] | nil,
  secretVolumes: [GoogleApi.CloudFunctions.V1.Model.SecretVolume.t()] | nil,
  serviceAccountEmail: String.t() | nil,
  sourceArchiveUrl: String.t() | nil,
  sourceRepository:
    GoogleApi.CloudFunctions.V1.Model.SourceRepository.t() | nil,
  sourceToken: String.t() | nil,
  sourceUploadUrl: String.t() | nil,
  status: String.t() | nil,
  timeout: String.t() | nil,
  updateTime: DateTime.t() | nil,
  versionId: String.t() | nil,
  vpcConnector: String.t() | nil,
  vpcConnectorEgressSettings: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.