GetFunction

Get information about a Google Cloud Function. For more information see the official documentation and API.

Using GetFunction

function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>

function  get_function(name=None, project=None, region=None, opts=None)

func LookupFunction(ctx *Context, args *LookupFunctionArgs, opts ...InvokeOption) (*LookupFunctionResult, error)

Note: This function is named LookupFunction in the Go SDK.

public static class GetFunction {
    public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of a Cloud Function.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region in which the resource belongs. If it is not provided, the provider region is used.

Name string: The name of a Cloud Function.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region in which the resource belongs. If it is not provided, the provider region is used.

name string: The name of a Cloud Function.
project string: The project in which the resource belongs. If it is not provided, the provider project is used.
region string: The region in which the resource belongs. If it is not provided, the provider region is used.

name str: The name of a Cloud Function.
project str: The project in which the resource belongs. If it is not provided, the provider project is used.
region str: The region in which the resource belongs. If it is not provided, the provider region is used.

GetFunction Result

The following output properties are available:

AvailableMemoryMb int: Available memory (in MB) to the function.
Description string: Description of the function.
EntryPoint string: Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
EnvironmentVariables Dictionary<string, object>
EventTriggers List<GetFunctionEventTrigger>: A source that fires events in response to a condition in another service. Structure is documented below.
HttpsTriggerUrl string: If function is triggered by HTTP, trigger URL is set here.
Id string: The provider-assigned unique ID for this managed resource.
IngressSettings string: Controls what traffic can reach the function.
Labels Dictionary<string, object>: A map of labels applied to this function.
MaxInstances int
Name string: The name of the Cloud Function.
Runtime string: The runtime in which the function is running.
ServiceAccountEmail string: The service account email to be assumed by the cloud function.
SourceArchiveBucket string: The GCS bucket containing the zip archive which contains the function.
SourceArchiveObject string: The source archive object (file) in archive bucket.
SourceRepositories List<GetFunctionSourceRepository>
Timeout int: Function execution timeout (in seconds).
TriggerHttp bool: If function is triggered by HTTP, this boolean is set.
VpcConnector string: The VPC Network Connector that this cloud function can connect to.
VpcConnectorEgressSettings string: The egress settings for the connector, controlling what traffic is diverted through it.
Project string
Region string

AvailableMemoryMb int: Available memory (in MB) to the function.
Description string: Description of the function.
EntryPoint string: Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
EnvironmentVariables map[string]interface{}
EventTriggers []GetFunctionEventTrigger: A source that fires events in response to a condition in another service. Structure is documented below.
HttpsTriggerUrl string: If function is triggered by HTTP, trigger URL is set here.
Id string: The provider-assigned unique ID for this managed resource.
IngressSettings string: Controls what traffic can reach the function.
Labels map[string]interface{}: A map of labels applied to this function.
MaxInstances int
Name string: The name of the Cloud Function.
Runtime string: The runtime in which the function is running.
ServiceAccountEmail string: The service account email to be assumed by the cloud function.
SourceArchiveBucket string: The GCS bucket containing the zip archive which contains the function.
SourceArchiveObject string: The source archive object (file) in archive bucket.
SourceRepositories []GetFunctionSourceRepository
Timeout int: Function execution timeout (in seconds).
TriggerHttp bool: If function is triggered by HTTP, this boolean is set.
VpcConnector string: The VPC Network Connector that this cloud function can connect to.
VpcConnectorEgressSettings string: The egress settings for the connector, controlling what traffic is diverted through it.
Project string
Region string

availableMemoryMb number: Available memory (in MB) to the function.
description string: Description of the function.
entryPoint string: Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
environmentVariables {[key: string]: any}
eventTriggers GetFunctionEventTrigger[]: A source that fires events in response to a condition in another service. Structure is documented below.
httpsTriggerUrl string: If function is triggered by HTTP, trigger URL is set here.
id string: The provider-assigned unique ID for this managed resource.
ingressSettings string: Controls what traffic can reach the function.
labels {[key: string]: any}: A map of labels applied to this function.
maxInstances number
name string: The name of the Cloud Function.
runtime string: The runtime in which the function is running.
serviceAccountEmail string: The service account email to be assumed by the cloud function.
sourceArchiveBucket string: The GCS bucket containing the zip archive which contains the function.
sourceArchiveObject string: The source archive object (file) in archive bucket.
sourceRepositories GetFunctionSourceRepository[]
timeout number: Function execution timeout (in seconds).
triggerHttp boolean: If function is triggered by HTTP, this boolean is set.
vpcConnector string: The VPC Network Connector that this cloud function can connect to.
vpcConnectorEgressSettings string: The egress settings for the connector, controlling what traffic is diverted through it.
project string
region string

available_memory_mb float: Available memory (in MB) to the function.
description str: Description of the function.
entry_point str: Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
environment_variables Dict[str, Any]
event_triggers List[GetFunctionEventTrigger]: A source that fires events in response to a condition in another service. Structure is documented below.
https_trigger_url str: If function is triggered by HTTP, trigger URL is set here.
id str: The provider-assigned unique ID for this managed resource.
ingress_settings str: Controls what traffic can reach the function.
labels Dict[str, Any]: A map of labels applied to this function.
max_instances float
name str: The name of the Cloud Function.
runtime str: The runtime in which the function is running.
service_account_email str: The service account email to be assumed by the cloud function.
source_archive_bucket str: The GCS bucket containing the zip archive which contains the function.
source_archive_object str: The source archive object (file) in archive bucket.
source_repositories List[GetFunctionSourceRepository]
timeout float: Function execution timeout (in seconds).
trigger_http bool: If function is triggered by HTTP, this boolean is set.
vpc_connector str: The VPC Network Connector that this cloud function can connect to.
vpc_connector_egress_settings str: The egress settings for the connector, controlling what traffic is diverted through it.
project str
region str

Supporting Types

GetFunctionEventTrigger

See the output API doc for this type.

EventType string: The type of event to observe. For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.
FailurePolicies List<GetFunctionEventTriggerFailurePolicyArgs>: Policy for failed executions. Structure is documented below.
Resource string: The name of the resource whose events are being observed, for example, "myBucket"

EventType string: The type of event to observe. For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.
FailurePolicies []GetFunctionEventTriggerFailurePolicy: Policy for failed executions. Structure is documented below.
Resource string: The name of the resource whose events are being observed, for example, "myBucket"

eventType string: The type of event to observe. For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.
failurePolicies GetFunctionEventTriggerFailurePolicy[]: Policy for failed executions. Structure is documented below.
resource string: The name of the resource whose events are being observed, for example, "myBucket"

eventType str: The type of event to observe. For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.
failurePolicies List[GetFunctionEventTriggerFailurePolicy]: Policy for failed executions. Structure is documented below.
resource str: The name of the resource whose events are being observed, for example, "myBucket"

GetFunctionEventTriggerFailurePolicy

See the output API doc for this type.

Retry bool: Whether the function should be retried on failure.

Retry bool: Whether the function should be retried on failure.

retry boolean: Whether the function should be retried on failure.

retry bool: Whether the function should be retried on failure.

GetFunctionSourceRepository

See the output API doc for this type.

DeployedUrl string
Url string

DeployedUrl string
Url string

deployedUrl string
url string

deployedUrl str
url str

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetFunction

Using GetFunction

GetFunction Result

Supporting Types

GetFunctionEventTrigger

GetFunctionEventTriggerFailurePolicy

GetFunctionSourceRepository

Package Details

On This Page