cloudfunctions

package
v0.15.0-rc3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 13, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Function 

type Function struct {
	// contains filtered or unexported fields
}

Creates a new Cloud Function. For more information see [the official documentation](https://cloud.google.com/functions/docs/) and [API](https://cloud.google.com/functions/docs/apis).

func GetFunction 

func GetFunction(ctx *pulumi.Context,
	name string, id pulumi.ID, state *FunctionState, opts ...pulumi.ResourceOpt) (*Function, error)

GetFunction gets an existing Function resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewFunction 

func NewFunction(ctx *pulumi.Context,
	name string, args *FunctionArgs, opts ...pulumi.ResourceOpt) (*Function, error)

NewFunction registers a new resource with the given unique name, arguments, and options.

func (*Function) AvailableMemoryMb 

func (r *Function) AvailableMemoryMb() *pulumi.IntOutput

Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.

func (*Function) Description 

func (r *Function) Description() *pulumi.StringOutput

Description of the function.

func (*Function) EntryPoint 

func (r *Function) EntryPoint() *pulumi.StringOutput

Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.

func (*Function) HttpsTriggerUrl 

func (r *Function) HttpsTriggerUrl() *pulumi.StringOutput

URL which triggers function execution. Returned only if `trigger_http` is used.

func (*Function) ID 

func (r *Function) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Function) Labels 

func (r *Function) Labels() *pulumi.MapOutput

A set of key/value label pairs to assign to the function.

func (*Function) Name 

func (r *Function) Name() *pulumi.StringOutput

A user-defined name of the function. Function names must be unique globally.

func (*Function) Project 

func (r *Function) Project() *pulumi.StringOutput

Project of the function. If it is not provided, the provider project is used.

func (*Function) Region 

func (r *Function) Region() *pulumi.StringOutput

Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.

func (*Function) RetryOnFailure 

func (r *Function) RetryOnFailure() *pulumi.BoolOutput

Whether the function should be retried on failure. This only applies to bucket and topic triggers, not HTTPS triggers.

func (*Function) SourceArchiveBucket 

func (r *Function) SourceArchiveBucket() *pulumi.StringOutput

The GCS bucket containing the zip archive which contains the function.

func (*Function) SourceArchiveObject 

func (r *Function) SourceArchiveObject() *pulumi.StringOutput

The source archive object (file) in archive bucket.

func (*Function) Timeout 

func (r *Function) Timeout() *pulumi.IntOutput

Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.

func (*Function) TriggerBucket 

func (r *Function) TriggerBucket() *pulumi.StringOutput

Google Cloud Storage bucket name. Every change in files in this bucket will trigger function execution. Cannot be used with `trigger_http` and `trigger_topic`.

func (*Function) TriggerHttp 

func (r *Function) TriggerHttp() *pulumi.BoolOutput

Boolean variable. Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as `https_trigger_url`. Cannot be used with `trigger_bucket` and `trigger_topic`.

func (*Function) TriggerTopic 

func (r *Function) TriggerTopic() *pulumi.StringOutput

Name of Pub/Sub topic. Every message published in this topic will trigger function execution with message contents passed as input data. Cannot be used with `trigger_http` and `trigger_bucket`.

func (*Function) URN 

func (r *Function) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type FunctionArgs 

type FunctionArgs struct {
	// Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.
	AvailableMemoryMb interface{}
	// Description of the function.
	Description interface{}
	// Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
	EntryPoint interface{}
	// URL which triggers function execution. Returned only if `trigger_http` is used.
	HttpsTriggerUrl interface{}
	// A set of key/value label pairs to assign to the function.
	Labels interface{}
	// A user-defined name of the function. Function names must be unique globally.
	Name interface{}
	// Project of the function. If it is not provided, the provider project is used.
	Project interface{}
	// Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.
	Region interface{}
	// Whether the function should be retried on failure. This only applies to bucket and topic triggers, not HTTPS triggers.
	RetryOnFailure interface{}
	// The GCS bucket containing the zip archive which contains the function.
	SourceArchiveBucket interface{}
	// The source archive object (file) in archive bucket.
	SourceArchiveObject interface{}
	// Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
	Timeout interface{}
	// Google Cloud Storage bucket name. Every change in files in this bucket will trigger function execution. Cannot be used with `trigger_http` and `trigger_topic`.
	TriggerBucket interface{}
	// Boolean variable. Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as `https_trigger_url`. Cannot be used with `trigger_bucket` and `trigger_topic`.
	TriggerHttp interface{}
	// Name of Pub/Sub topic. Every message published in this topic will trigger function execution with message contents passed as input data. Cannot be used with `trigger_http` and `trigger_bucket`.
	TriggerTopic interface{}
}

The set of arguments for constructing a Function resource.

type FunctionState 

type FunctionState struct {
	// Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.
	AvailableMemoryMb interface{}
	// Description of the function.
	Description interface{}
	// Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
	EntryPoint interface{}
	// URL which triggers function execution. Returned only if `trigger_http` is used.
	HttpsTriggerUrl interface{}
	// A set of key/value label pairs to assign to the function.
	Labels interface{}
	// A user-defined name of the function. Function names must be unique globally.
	Name interface{}
	// Project of the function. If it is not provided, the provider project is used.
	Project interface{}
	// Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.
	Region interface{}
	// Whether the function should be retried on failure. This only applies to bucket and topic triggers, not HTTPS triggers.
	RetryOnFailure interface{}
	// The GCS bucket containing the zip archive which contains the function.
	SourceArchiveBucket interface{}
	// The source archive object (file) in archive bucket.
	SourceArchiveObject interface{}
	// Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
	Timeout interface{}
	// Google Cloud Storage bucket name. Every change in files in this bucket will trigger function execution. Cannot be used with `trigger_http` and `trigger_topic`.
	TriggerBucket interface{}
	// Boolean variable. Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as `https_trigger_url`. Cannot be used with `trigger_bucket` and `trigger_topic`.
	TriggerHttp interface{}
	// Name of Pub/Sub topic. Every message published in this topic will trigger function execution with message contents passed as input data. Cannot be used with `trigger_http` and `trigger_bucket`.
	TriggerTopic interface{}
}

Input properties used for looking up and filtering Function resources.

type GetFunctionArgs 

type GetFunctionArgs struct {
	// The name of a Cloud Function.
	Name interface{}
	// The project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// The region in which the resource belongs. If it
	// is not provided, the provider region is used.
	Region interface{}
}

A collection of arguments for invoking getFunction.

type GetFunctionResult 

type GetFunctionResult struct {
	// Available memory (in MB) to the function.
	AvailableMemoryMb interface{}
	// Description of the function.
	Description interface{}
	// Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
	EntryPoint interface{}
	// If function is triggered by HTTP, trigger URL is set here.
	HttpsTriggerUrl interface{}
	// A map of labels applied to this function.
	Labels         interface{}
	RetryOnFailure interface{}
	// The GCS bucket containing the zip archive which contains the function.
	SourceArchiveBucket interface{}
	// The source archive object (file) in archive bucket.
	SourceArchiveObject interface{}
	// Function execution timeout (in seconds).
	Timeout interface{}
	// If function is triggered by bucket, bucket name is set here.
	TriggerBucket interface{}
	// If function is triggered by HTTP, this boolean is set.
	TriggerHttp interface{}
	// If function is triggered by Pub/Sub topic, name of topic is set here.
	TriggerTopic interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getFunction.

func LookupFunction 

func LookupFunction(ctx *pulumi.Context, args *GetFunctionArgs) (*GetFunctionResult, error)

Get information about a Google Cloud Function. For more information see the [official documentation](https://cloud.google.com/functions/docs/) and [API](https://cloud.google.com/functions/docs/apis).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.