functions

package
v0.0.0-...-dd2ea8e Latest Latest
Warning

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

Go to latest
Published: Nov 4, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	CloudFunctionStatus_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "READY",
		2: "FAILED",
		3: "DEPLOYING",
		4: "DELETING",
	}
	CloudFunctionStatus_value = map[string]int32{
		"STATUS_UNSPECIFIED": 0,
		"READY":              1,
		"FAILED":             2,
		"DEPLOYING":          3,
		"DELETING":           4,
	}
)

Enum value maps for CloudFunctionStatus.

View Source
var (
	OperationType_name = map[int32]string{
		0: "OPERATION_UNSPECIFIED",
		1: "CREATE_FUNCTION",
		2: "UPDATE_FUNCTION",
		3: "DELETE_FUNCTION",
	}
	OperationType_value = map[string]int32{
		"OPERATION_UNSPECIFIED": 0,
		"CREATE_FUNCTION":       1,
		"UPDATE_FUNCTION":       2,
		"DELETE_FUNCTION":       3,
	}
)

Enum value maps for OperationType.

View Source
var File_google_cloud_functions_v1beta2_functions_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_functions_v1beta2_operations_proto protoreflect.FileDescriptor

Functions

func RegisterCloudFunctionsServiceServer

func RegisterCloudFunctionsServiceServer(s *grpc.Server, srv CloudFunctionsServiceServer)

Types

type CallFunctionRequest

type CallFunctionRequest struct {

	// Required. The name of the function to be called.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Input to be passed to the function.
	Data string `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Request for the `CallFunction` method.

func (*CallFunctionRequest) Descriptor deprecated

func (*CallFunctionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CallFunctionRequest.ProtoReflect.Descriptor instead.

func (*CallFunctionRequest) GetData

func (x *CallFunctionRequest) GetData() string

func (*CallFunctionRequest) GetName

func (x *CallFunctionRequest) GetName() string

func (*CallFunctionRequest) ProtoMessage

func (*CallFunctionRequest) ProtoMessage()

func (*CallFunctionRequest) ProtoReflect

func (x *CallFunctionRequest) ProtoReflect() protoreflect.Message

func (*CallFunctionRequest) Reset

func (x *CallFunctionRequest) Reset()

func (*CallFunctionRequest) String

func (x *CallFunctionRequest) String() string

type CallFunctionResponse

type CallFunctionResponse struct {

	// Execution id of function invocation.
	ExecutionId string `protobuf:"bytes,1,opt,name=execution_id,json=executionId,proto3" json:"execution_id,omitempty"`
	// Result populated for successful execution of synchronous function. Will
	// not be populated if function does not return a result through context.
	Result string `protobuf:"bytes,2,opt,name=result,proto3" json:"result,omitempty"`
	// Either system or user-function generated error. Set if execution
	// was not successful.
	Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

Response of `CallFunction` method.

func (*CallFunctionResponse) Descriptor deprecated

func (*CallFunctionResponse) Descriptor() ([]byte, []int)

Deprecated: Use CallFunctionResponse.ProtoReflect.Descriptor instead.

func (*CallFunctionResponse) GetError

func (x *CallFunctionResponse) GetError() string

func (*CallFunctionResponse) GetExecutionId

func (x *CallFunctionResponse) GetExecutionId() string

func (*CallFunctionResponse) GetResult

func (x *CallFunctionResponse) GetResult() string

func (*CallFunctionResponse) ProtoMessage

func (*CallFunctionResponse) ProtoMessage()

func (*CallFunctionResponse) ProtoReflect

func (x *CallFunctionResponse) ProtoReflect() protoreflect.Message

func (*CallFunctionResponse) Reset

func (x *CallFunctionResponse) Reset()

func (*CallFunctionResponse) String

func (x *CallFunctionResponse) String() string

type CloudFunction

type CloudFunction struct {

	// A user-defined name of the function. Function names must be unique
	// globally and match pattern `projects/*/locations/*/functions/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The location of the function source code.
	//
	// Types that are assignable to SourceCode:
	//	*CloudFunction_SourceArchiveUrl
	//	*CloudFunction_SourceRepository
	//	*CloudFunction_SourceRepositoryUrl
	//	*CloudFunction_SourceUploadUrl
	SourceCode isCloudFunction_SourceCode `protobuf_oneof:"source_code"`
	// An event that triggers the function.
	//
	// Types that are assignable to Trigger:
	//	*CloudFunction_HttpsTrigger
	//	*CloudFunction_EventTrigger
	Trigger isCloudFunction_Trigger `protobuf_oneof:"trigger"`
	// Output only. Status of the function deployment.
	Status CloudFunctionStatus `protobuf:"varint,7,opt,name=status,proto3,enum=google.cloud.functions.v1beta2.CloudFunctionStatus" json:"status,omitempty"`
	// Output only. Name of the most recent operation modifying the function. If
	// the function status is `DEPLOYING` or `DELETING`, then it points to the
	// active operation.
	LatestOperation string `protobuf:"bytes,8,opt,name=latest_operation,json=latestOperation,proto3" json:"latest_operation,omitempty"`
	// 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`.
	EntryPoint string `protobuf:"bytes,9,opt,name=entry_point,json=entryPoint,proto3" json:"entry_point,omitempty"`
	// 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](/sdk/gcloud/reference/functions/deploy#--runtime).
	Runtime string `protobuf:"bytes,23,opt,name=runtime,proto3" json:"runtime,omitempty"`
	// 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.
	Timeout *duration.Duration `protobuf:"bytes,10,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// The amount of memory in MB available for a function.
	// Defaults to 256MB.
	AvailableMemoryMb int32 `protobuf:"varint,11,opt,name=available_memory_mb,json=availableMemoryMb,proto3" json:"available_memory_mb,omitempty"`
	// The email of the function's service account. If empty, defaults to
	// `{project_id}@appspot.gserviceaccount.com`.
	ServiceAccount string `protobuf:"bytes,13,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Output only. The last update timestamp of a Cloud Function.
	UpdateTime *timestamp.Timestamp `protobuf:"bytes,15,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The version identifier of the Cloud Function. Each deployment attempt
	// results in a new version of a function being created.
	VersionId int64 `protobuf:"varint,20,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// Labels associated with this Cloud Function.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Environment variables that shall be available during function execution.
	EnvironmentVariables map[string]string `` /* 210-byte string literal not displayed */
	// The limit on the maximum number of function instances that may coexist at a
	// given time.
	MaxInstances int32 `protobuf:"varint,24,opt,name=max_instances,json=maxInstances,proto3" json:"max_instances,omitempty"`
	// 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](https://cloud.google.com/compute/docs/vpc) for
	// more information on connecting Cloud projects.
	Network string `protobuf:"bytes,25,opt,name=network,proto3" json:"network,omitempty"`
	// 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](https://cloud.google.com/compute/docs/vpc) for
	// more information on connecting Cloud projects.
	VpcConnector string `protobuf:"bytes,26,opt,name=vpc_connector,json=vpcConnector,proto3" json:"vpc_connector,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CloudFunction) Descriptor deprecated

func (*CloudFunction) Descriptor() ([]byte, []int)

Deprecated: Use CloudFunction.ProtoReflect.Descriptor instead.

func (*CloudFunction) GetAvailableMemoryMb

func (x *CloudFunction) GetAvailableMemoryMb() int32

func (*CloudFunction) GetEntryPoint

func (x *CloudFunction) GetEntryPoint() string

func (*CloudFunction) GetEnvironmentVariables

func (x *CloudFunction) GetEnvironmentVariables() map[string]string

func (*CloudFunction) GetEventTrigger

func (x *CloudFunction) GetEventTrigger() *EventTrigger

func (*CloudFunction) GetHttpsTrigger

func (x *CloudFunction) GetHttpsTrigger() *HTTPSTrigger

func (*CloudFunction) GetLabels

func (x *CloudFunction) GetLabels() map[string]string

func (*CloudFunction) GetLatestOperation

func (x *CloudFunction) GetLatestOperation() string

func (*CloudFunction) GetMaxInstances

func (x *CloudFunction) GetMaxInstances() int32

func (*CloudFunction) GetName

func (x *CloudFunction) GetName() string

func (*CloudFunction) GetNetwork

func (x *CloudFunction) GetNetwork() string

func (*CloudFunction) GetRuntime

func (x *CloudFunction) GetRuntime() string

func (*CloudFunction) GetServiceAccount

func (x *CloudFunction) GetServiceAccount() string

func (*CloudFunction) GetSourceArchiveUrl

func (x *CloudFunction) GetSourceArchiveUrl() string

func (*CloudFunction) GetSourceCode

func (m *CloudFunction) GetSourceCode() isCloudFunction_SourceCode

func (*CloudFunction) GetSourceRepository

func (x *CloudFunction) GetSourceRepository() *SourceRepository

func (*CloudFunction) GetSourceRepositoryUrl

func (x *CloudFunction) GetSourceRepositoryUrl() string

func (*CloudFunction) GetSourceUploadUrl

func (x *CloudFunction) GetSourceUploadUrl() string

func (*CloudFunction) GetStatus

func (x *CloudFunction) GetStatus() CloudFunctionStatus

func (*CloudFunction) GetTimeout

func (x *CloudFunction) GetTimeout() *duration.Duration

func (*CloudFunction) GetTrigger

func (m *CloudFunction) GetTrigger() isCloudFunction_Trigger

func (*CloudFunction) GetUpdateTime

func (x *CloudFunction) GetUpdateTime() *timestamp.Timestamp

func (*CloudFunction) GetVersionId

func (x *CloudFunction) GetVersionId() int64

func (*CloudFunction) GetVpcConnector

func (x *CloudFunction) GetVpcConnector() string

func (*CloudFunction) ProtoMessage

func (*CloudFunction) ProtoMessage()

func (*CloudFunction) ProtoReflect

func (x *CloudFunction) ProtoReflect() protoreflect.Message

func (*CloudFunction) Reset

func (x *CloudFunction) Reset()

func (*CloudFunction) String

func (x *CloudFunction) String() string

type CloudFunctionStatus

type CloudFunctionStatus int32

Describes the current stage of a deployment.

const (
	// Status not specified.
	CloudFunctionStatus_STATUS_UNSPECIFIED CloudFunctionStatus = 0
	// Successfully deployed.
	CloudFunctionStatus_READY CloudFunctionStatus = 1
	// Not deployed correctly - behavior is undefined. The item should be updated
	// or deleted to move it out of this state.
	CloudFunctionStatus_FAILED CloudFunctionStatus = 2
	// Creation or update in progress.
	CloudFunctionStatus_DEPLOYING CloudFunctionStatus = 3
	// Deletion in progress.
	CloudFunctionStatus_DELETING CloudFunctionStatus = 4
)

func (CloudFunctionStatus) Descriptor

func (CloudFunctionStatus) Enum

func (CloudFunctionStatus) EnumDescriptor deprecated

func (CloudFunctionStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use CloudFunctionStatus.Descriptor instead.

func (CloudFunctionStatus) Number

func (CloudFunctionStatus) String

func (x CloudFunctionStatus) String() string

func (CloudFunctionStatus) Type

type CloudFunction_EventTrigger

type CloudFunction_EventTrigger struct {
	// A source that fires events in response to a condition in another service.
	EventTrigger *EventTrigger `protobuf:"bytes,12,opt,name=event_trigger,json=eventTrigger,proto3,oneof"`
}

type CloudFunction_HttpsTrigger

type CloudFunction_HttpsTrigger struct {
	// An HTTPS endpoint type of source that can be triggered via URL.
	HttpsTrigger *HTTPSTrigger `protobuf:"bytes,6,opt,name=https_trigger,json=httpsTrigger,proto3,oneof"`
}

type CloudFunction_SourceArchiveUrl

type CloudFunction_SourceArchiveUrl struct {
	// The Google Cloud Storage URL, starting with gs://, pointing to the zip
	// archive which contains the function.
	SourceArchiveUrl string `protobuf:"bytes,14,opt,name=source_archive_url,json=sourceArchiveUrl,proto3,oneof"`
}

type CloudFunction_SourceRepository

type CloudFunction_SourceRepository struct {
	// The hosted repository where the function is defined.
	SourceRepository *SourceRepository `protobuf:"bytes,3,opt,name=source_repository,json=sourceRepository,proto3,oneof"`
}

type CloudFunction_SourceRepositoryUrl

type CloudFunction_SourceRepositoryUrl struct {
	// The URL pointing to the hosted repository where the function is defined.
	// There are supported Cloud Source Repository URLs in the following
	// formats:
	//
	// To refer to a specific commit:
	// `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`
	// To refer to a moveable alias (branch):
	// `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`
	// In particular, to refer to HEAD use `master` moveable alias.
	// To refer to a specific fixed alias (tag):
	// `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
	//
	// You may omit `paths/*` if you want to use the main directory.
	SourceRepositoryUrl string `protobuf:"bytes,18,opt,name=source_repository_url,json=sourceRepositoryUrl,proto3,oneof"`
}

type CloudFunction_SourceUploadUrl

type CloudFunction_SourceUploadUrl struct {
	// The Google Cloud Storage signed URL used for source uploading, generated
	// by [google.cloud.functions.v1beta2.GenerateUploadUrl][]
	SourceUploadUrl string `protobuf:"bytes,16,opt,name=source_upload_url,json=sourceUploadUrl,proto3,oneof"`
}

type CloudFunctionsServiceClient

type CloudFunctionsServiceClient interface {
	// Returns a list of functions that belong to the requested project.
	ListFunctions(ctx context.Context, in *ListFunctionsRequest, opts ...grpc.CallOption) (*ListFunctionsResponse, error)
	// Returns a function with the given name from the requested project.
	GetFunction(ctx context.Context, in *GetFunctionRequest, opts ...grpc.CallOption) (*CloudFunction, error)
	// Creates a new function. If a function with the given name already exists in
	// the specified project, the long running operation will return
	// `ALREADY_EXISTS` error.
	CreateFunction(ctx context.Context, in *CreateFunctionRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Updates existing function.
	UpdateFunction(ctx context.Context, in *UpdateFunctionRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Deletes a function with the given name from the specified project. If the
	// given function is used by some trigger, the trigger will be updated to
	// remove this function.
	DeleteFunction(ctx context.Context, in *DeleteFunctionRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Synchronously invokes a deployed Cloud Function. To be used for testing
	// purposes as very limited traffic is allowed. For more information on
	// the actual limits refer to [API Calls](
	// https://cloud.google.com/functions/quotas#rate_limits).
	CallFunction(ctx context.Context, in *CallFunctionRequest, opts ...grpc.CallOption) (*CallFunctionResponse, error)
	// Returns a signed URL for uploading a function source code.
	// For more information about the signed URL usage see:
	// https://cloud.google.com/storage/docs/access-control/signed-urls
	// Once the function source code upload is complete, the used signed
	// URL should be provided in CreateFunction or UpdateFunction request
	// as a reference to the function source code.
	//
	// When uploading source code to the generated signed URL, please follow
	// these restrictions:
	//
	// * Source file type should be a zip file.
	// * Source file size should not exceed 100MB limit.
	// * No credentials should be attached - the signed URLs provide access to the
	//   target bucket using internal service identity; if credentials were
	//   attached, the identity from the credentials would be used, but that
	//   identity does not have permissions to upload files to the URL.
	//
	// When making a HTTP PUT request, these two headers need to be specified:
	//
	// * `content-type: application/zip`
	// * `x-goog-content-length-range: 0,104857600`
	//
	// And this header SHOULD NOT be specified:
	//
	// * `Authorization: Bearer YOUR_TOKEN`
	GenerateUploadUrl(ctx context.Context, in *GenerateUploadUrlRequest, opts ...grpc.CallOption) (*GenerateUploadUrlResponse, error)
	// Returns a signed URL for downloading deployed function source code.
	// The URL is only valid for a limited period and should be used within
	// minutes after generation.
	// For more information about the signed URL usage see:
	// https://cloud.google.com/storage/docs/access-control/signed-urls
	GenerateDownloadUrl(ctx context.Context, in *GenerateDownloadUrlRequest, opts ...grpc.CallOption) (*GenerateDownloadUrlResponse, error)
}

CloudFunctionsServiceClient is the client API for CloudFunctionsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type CloudFunctionsServiceServer

type CloudFunctionsServiceServer interface {
	// Returns a list of functions that belong to the requested project.
	ListFunctions(context.Context, *ListFunctionsRequest) (*ListFunctionsResponse, error)
	// Returns a function with the given name from the requested project.
	GetFunction(context.Context, *GetFunctionRequest) (*CloudFunction, error)
	// Creates a new function. If a function with the given name already exists in
	// the specified project, the long running operation will return
	// `ALREADY_EXISTS` error.
	CreateFunction(context.Context, *CreateFunctionRequest) (*longrunning.Operation, error)
	// Updates existing function.
	UpdateFunction(context.Context, *UpdateFunctionRequest) (*longrunning.Operation, error)
	// Deletes a function with the given name from the specified project. If the
	// given function is used by some trigger, the trigger will be updated to
	// remove this function.
	DeleteFunction(context.Context, *DeleteFunctionRequest) (*longrunning.Operation, error)
	// Synchronously invokes a deployed Cloud Function. To be used for testing
	// purposes as very limited traffic is allowed. For more information on
	// the actual limits refer to [API Calls](
	// https://cloud.google.com/functions/quotas#rate_limits).
	CallFunction(context.Context, *CallFunctionRequest) (*CallFunctionResponse, error)
	// Returns a signed URL for uploading a function source code.
	// For more information about the signed URL usage see:
	// https://cloud.google.com/storage/docs/access-control/signed-urls
	// Once the function source code upload is complete, the used signed
	// URL should be provided in CreateFunction or UpdateFunction request
	// as a reference to the function source code.
	//
	// When uploading source code to the generated signed URL, please follow
	// these restrictions:
	//
	// * Source file type should be a zip file.
	// * Source file size should not exceed 100MB limit.
	// * No credentials should be attached - the signed URLs provide access to the
	//   target bucket using internal service identity; if credentials were
	//   attached, the identity from the credentials would be used, but that
	//   identity does not have permissions to upload files to the URL.
	//
	// When making a HTTP PUT request, these two headers need to be specified:
	//
	// * `content-type: application/zip`
	// * `x-goog-content-length-range: 0,104857600`
	//
	// And this header SHOULD NOT be specified:
	//
	// * `Authorization: Bearer YOUR_TOKEN`
	GenerateUploadUrl(context.Context, *GenerateUploadUrlRequest) (*GenerateUploadUrlResponse, error)
	// Returns a signed URL for downloading deployed function source code.
	// The URL is only valid for a limited period and should be used within
	// minutes after generation.
	// For more information about the signed URL usage see:
	// https://cloud.google.com/storage/docs/access-control/signed-urls
	GenerateDownloadUrl(context.Context, *GenerateDownloadUrlRequest) (*GenerateDownloadUrlResponse, error)
}

CloudFunctionsServiceServer is the server API for CloudFunctionsService service.

type CreateFunctionRequest

type CreateFunctionRequest struct {

	// Required. The project and location in which the function should be created, specified
	// in the format `projects/*/locations/*`
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// Required. Function to be created.
	Function *CloudFunction `protobuf:"bytes,2,opt,name=function,proto3" json:"function,omitempty"`
	// contains filtered or unexported fields
}

Request for the `CreateFunction` method.

func (*CreateFunctionRequest) Descriptor deprecated

func (*CreateFunctionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFunctionRequest.ProtoReflect.Descriptor instead.

func (*CreateFunctionRequest) GetFunction

func (x *CreateFunctionRequest) GetFunction() *CloudFunction

func (*CreateFunctionRequest) GetLocation

func (x *CreateFunctionRequest) GetLocation() string

func (*CreateFunctionRequest) ProtoMessage

func (*CreateFunctionRequest) ProtoMessage()

func (*CreateFunctionRequest) ProtoReflect

func (x *CreateFunctionRequest) ProtoReflect() protoreflect.Message

func (*CreateFunctionRequest) Reset

func (x *CreateFunctionRequest) Reset()

func (*CreateFunctionRequest) String

func (x *CreateFunctionRequest) String() string

type DeleteFunctionRequest

type DeleteFunctionRequest struct {

	// Required. The name of the function which should be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the `DeleteFunction` method.

func (*DeleteFunctionRequest) Descriptor deprecated

func (*DeleteFunctionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFunctionRequest.ProtoReflect.Descriptor instead.

func (*DeleteFunctionRequest) GetName

func (x *DeleteFunctionRequest) GetName() string

func (*DeleteFunctionRequest) ProtoMessage

func (*DeleteFunctionRequest) ProtoMessage()

func (*DeleteFunctionRequest) ProtoReflect

func (x *DeleteFunctionRequest) ProtoReflect() protoreflect.Message

func (*DeleteFunctionRequest) Reset

func (x *DeleteFunctionRequest) Reset()

func (*DeleteFunctionRequest) String

func (x *DeleteFunctionRequest) String() string

type EventTrigger

type EventTrigger struct {

	// `event_type` names contain the service that is sending an event and the
	// kind of event that was fired. Must be of the form
	// `providers/*/eventTypes/*` e.g. Directly handle a Message published to
	// Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
	//
	// Handle an object changing in Google Cloud Storage:
	// `providers/cloud.storage/eventTypes/object.change`
	//
	// Handle a write to the Firebase Realtime Database:
	// `providers/google.firebase.database/eventTypes/ref.write`
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Which instance of the source's service should send events. E.g. for Pub/Sub
	// this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud
	// Storage this would be a bucket at `projects/*/buckets/*`. For any source
	// that only supports one instance per-project, this should be the name of the
	// project (`projects/*`)
	Resource string `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
	// The hostname of the service that should be observed.
	//
	// If no string is provided, the default service implementing the API will
	// be used. For example, `storage.googleapis.com` is the default for all
	// event types in the `google.storage` namespace.
	Service string `protobuf:"bytes,6,opt,name=service,proto3" json:"service,omitempty"`
	// Specifies policy for failed executions.
	FailurePolicy *FailurePolicy `protobuf:"bytes,5,opt,name=failure_policy,json=failurePolicy,proto3" json:"failure_policy,omitempty"`
	// contains filtered or unexported fields
}

Describes EventTrigger, used to request events be sent from another service.

func (*EventTrigger) Descriptor deprecated

func (*EventTrigger) Descriptor() ([]byte, []int)

Deprecated: Use EventTrigger.ProtoReflect.Descriptor instead.

func (*EventTrigger) GetEventType

func (x *EventTrigger) GetEventType() string

func (*EventTrigger) GetFailurePolicy

func (x *EventTrigger) GetFailurePolicy() *FailurePolicy

func (*EventTrigger) GetResource

func (x *EventTrigger) GetResource() string

func (*EventTrigger) GetService

func (x *EventTrigger) GetService() string

func (*EventTrigger) ProtoMessage

func (*EventTrigger) ProtoMessage()

func (*EventTrigger) ProtoReflect

func (x *EventTrigger) ProtoReflect() protoreflect.Message

func (*EventTrigger) Reset

func (x *EventTrigger) Reset()

func (*EventTrigger) String

func (x *EventTrigger) String() string

type FailurePolicy

type FailurePolicy struct {

	// Defines the action taken in case of a function execution failure.
	//
	// Types that are assignable to Action:
	//	*FailurePolicy_Retry_
	Action isFailurePolicy_Action `protobuf_oneof:"action"`
	// contains filtered or unexported fields
}

Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).

func (*FailurePolicy) Descriptor deprecated

func (*FailurePolicy) Descriptor() ([]byte, []int)

Deprecated: Use FailurePolicy.ProtoReflect.Descriptor instead.

func (*FailurePolicy) GetAction

func (m *FailurePolicy) GetAction() isFailurePolicy_Action

func (*FailurePolicy) GetRetry

func (x *FailurePolicy) GetRetry() *FailurePolicy_Retry

func (*FailurePolicy) ProtoMessage

func (*FailurePolicy) ProtoMessage()

func (*FailurePolicy) ProtoReflect

func (x *FailurePolicy) ProtoReflect() protoreflect.Message

func (*FailurePolicy) Reset

func (x *FailurePolicy) Reset()

func (*FailurePolicy) String

func (x *FailurePolicy) String() string

type FailurePolicy_Retry

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

Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.

func (*FailurePolicy_Retry) Descriptor deprecated

func (*FailurePolicy_Retry) Descriptor() ([]byte, []int)

Deprecated: Use FailurePolicy_Retry.ProtoReflect.Descriptor instead.

func (*FailurePolicy_Retry) ProtoMessage

func (*FailurePolicy_Retry) ProtoMessage()

func (*FailurePolicy_Retry) ProtoReflect

func (x *FailurePolicy_Retry) ProtoReflect() protoreflect.Message

func (*FailurePolicy_Retry) Reset

func (x *FailurePolicy_Retry) Reset()

func (*FailurePolicy_Retry) String

func (x *FailurePolicy_Retry) String() string

type FailurePolicy_Retry_

type FailurePolicy_Retry_ struct {
	// If specified, then the function will be retried in case of a failure.
	Retry *FailurePolicy_Retry `protobuf:"bytes,1,opt,name=retry,proto3,oneof"`
}

type GenerateDownloadUrlRequest

type GenerateDownloadUrlRequest struct {

	// The name of function for which source code Google Cloud Storage signed
	// URL should be generated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The optional version of function.
	VersionId uint64 `protobuf:"varint,2,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// contains filtered or unexported fields
}

Request of `GenerateDownloadUrl` method.

func (*GenerateDownloadUrlRequest) Descriptor deprecated

func (*GenerateDownloadUrlRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateDownloadUrlRequest.ProtoReflect.Descriptor instead.

func (*GenerateDownloadUrlRequest) GetName

func (x *GenerateDownloadUrlRequest) GetName() string

func (*GenerateDownloadUrlRequest) GetVersionId

func (x *GenerateDownloadUrlRequest) GetVersionId() uint64

func (*GenerateDownloadUrlRequest) ProtoMessage

func (*GenerateDownloadUrlRequest) ProtoMessage()

func (*GenerateDownloadUrlRequest) ProtoReflect

func (*GenerateDownloadUrlRequest) Reset

func (x *GenerateDownloadUrlRequest) Reset()

func (*GenerateDownloadUrlRequest) String

func (x *GenerateDownloadUrlRequest) String() string

type GenerateDownloadUrlResponse

type GenerateDownloadUrlResponse struct {

	// The generated Google Cloud Storage signed URL that should be used for
	// function source code download.
	DownloadUrl string `protobuf:"bytes,1,opt,name=download_url,json=downloadUrl,proto3" json:"download_url,omitempty"`
	// contains filtered or unexported fields
}

Response of `GenerateDownloadUrl` method.

func (*GenerateDownloadUrlResponse) Descriptor deprecated

func (*GenerateDownloadUrlResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateDownloadUrlResponse.ProtoReflect.Descriptor instead.

func (*GenerateDownloadUrlResponse) GetDownloadUrl

func (x *GenerateDownloadUrlResponse) GetDownloadUrl() string

func (*GenerateDownloadUrlResponse) ProtoMessage

func (*GenerateDownloadUrlResponse) ProtoMessage()

func (*GenerateDownloadUrlResponse) ProtoReflect

func (*GenerateDownloadUrlResponse) Reset

func (x *GenerateDownloadUrlResponse) Reset()

func (*GenerateDownloadUrlResponse) String

func (x *GenerateDownloadUrlResponse) String() string

type GenerateUploadUrlRequest

type GenerateUploadUrlRequest struct {

	// The project and location in which the Google Cloud Storage signed URL
	// should be generated, specified in the format `projects/*/locations/*`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Request of `GenerateUploadUrl` method.

func (*GenerateUploadUrlRequest) Descriptor deprecated

func (*GenerateUploadUrlRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateUploadUrlRequest.ProtoReflect.Descriptor instead.

func (*GenerateUploadUrlRequest) GetParent

func (x *GenerateUploadUrlRequest) GetParent() string

func (*GenerateUploadUrlRequest) ProtoMessage

func (*GenerateUploadUrlRequest) ProtoMessage()

func (*GenerateUploadUrlRequest) ProtoReflect

func (x *GenerateUploadUrlRequest) ProtoReflect() protoreflect.Message

func (*GenerateUploadUrlRequest) Reset

func (x *GenerateUploadUrlRequest) Reset()

func (*GenerateUploadUrlRequest) String

func (x *GenerateUploadUrlRequest) String() string

type GenerateUploadUrlResponse

type GenerateUploadUrlResponse struct {

	// The generated Google Cloud Storage signed URL that should be used for a
	// function source code upload. The uploaded file should be a zip archive
	// which contains a function.
	UploadUrl string `protobuf:"bytes,1,opt,name=upload_url,json=uploadUrl,proto3" json:"upload_url,omitempty"`
	// contains filtered or unexported fields
}

Response of `GenerateUploadUrl` method.

func (*GenerateUploadUrlResponse) Descriptor deprecated

func (*GenerateUploadUrlResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateUploadUrlResponse.ProtoReflect.Descriptor instead.

func (*GenerateUploadUrlResponse) GetUploadUrl

func (x *GenerateUploadUrlResponse) GetUploadUrl() string

func (*GenerateUploadUrlResponse) ProtoMessage

func (*GenerateUploadUrlResponse) ProtoMessage()

func (*GenerateUploadUrlResponse) ProtoReflect

func (*GenerateUploadUrlResponse) Reset

func (x *GenerateUploadUrlResponse) Reset()

func (*GenerateUploadUrlResponse) String

func (x *GenerateUploadUrlResponse) String() string

type GetFunctionRequest

type GetFunctionRequest struct {

	// Required. The name of the function which details should be obtained.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the `GetFunction` method.

func (*GetFunctionRequest) Descriptor deprecated

func (*GetFunctionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFunctionRequest.ProtoReflect.Descriptor instead.

func (*GetFunctionRequest) GetName

func (x *GetFunctionRequest) GetName() string

func (*GetFunctionRequest) ProtoMessage

func (*GetFunctionRequest) ProtoMessage()

func (*GetFunctionRequest) ProtoReflect

func (x *GetFunctionRequest) ProtoReflect() protoreflect.Message

func (*GetFunctionRequest) Reset

func (x *GetFunctionRequest) Reset()

func (*GetFunctionRequest) String

func (x *GetFunctionRequest) String() string

type HTTPSTrigger

type HTTPSTrigger struct {

	// Output only. The deployed url for the function.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

Describes HTTPSTrigger, could be used to connect web hooks to function.

func (*HTTPSTrigger) Descriptor deprecated

func (*HTTPSTrigger) Descriptor() ([]byte, []int)

Deprecated: Use HTTPSTrigger.ProtoReflect.Descriptor instead.

func (*HTTPSTrigger) GetUrl

func (x *HTTPSTrigger) GetUrl() string

func (*HTTPSTrigger) ProtoMessage

func (*HTTPSTrigger) ProtoMessage()

func (*HTTPSTrigger) ProtoReflect

func (x *HTTPSTrigger) ProtoReflect() protoreflect.Message

func (*HTTPSTrigger) Reset

func (x *HTTPSTrigger) Reset()

func (*HTTPSTrigger) String

func (x *HTTPSTrigger) String() string

type ListFunctionsRequest

type ListFunctionsRequest struct {

	// Required. The project and location from which the function should be listed,
	// specified in the format `projects/*/locations/*`
	// If you want to list functions in all locations, use "-" in place of a
	// location. When listing functions in all locations, if one or more
	// location(s) are unreachable, the response will contain functions from all
	// reachable locations along with the names of any unreachable locations.
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// Maximum number of functions to return per call.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The value returned by the last
	// `ListFunctionsResponse`; indicates that
	// this is a continuation of a prior `ListFunctions` call, and that the
	// system should return the next page of data.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for the `ListFunctions` method.

func (*ListFunctionsRequest) Descriptor deprecated

func (*ListFunctionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFunctionsRequest.ProtoReflect.Descriptor instead.

func (*ListFunctionsRequest) GetLocation

func (x *ListFunctionsRequest) GetLocation() string

func (*ListFunctionsRequest) GetPageSize

func (x *ListFunctionsRequest) GetPageSize() int32

func (*ListFunctionsRequest) GetPageToken

func (x *ListFunctionsRequest) GetPageToken() string

func (*ListFunctionsRequest) ProtoMessage

func (*ListFunctionsRequest) ProtoMessage()

func (*ListFunctionsRequest) ProtoReflect

func (x *ListFunctionsRequest) ProtoReflect() protoreflect.Message

func (*ListFunctionsRequest) Reset

func (x *ListFunctionsRequest) Reset()

func (*ListFunctionsRequest) String

func (x *ListFunctionsRequest) String() string

type ListFunctionsResponse

type ListFunctionsResponse struct {

	// The functions that match the request.
	Functions []*CloudFunction `protobuf:"bytes,1,rep,name=functions,proto3" json:"functions,omitempty"`
	// If not empty, indicates that there may be more functions that match
	// the request; this value should be passed in a new
	// [google.cloud.functions.v1beta2.ListFunctionsRequest][google.cloud.functions.v1beta2.ListFunctionsRequest]
	// to get more functions.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached. The response does not include any
	// functions from these locations.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response for the `ListFunctions` method.

func (*ListFunctionsResponse) Descriptor deprecated

func (*ListFunctionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFunctionsResponse.ProtoReflect.Descriptor instead.

func (*ListFunctionsResponse) GetFunctions

func (x *ListFunctionsResponse) GetFunctions() []*CloudFunction

func (*ListFunctionsResponse) GetNextPageToken

func (x *ListFunctionsResponse) GetNextPageToken() string

func (*ListFunctionsResponse) GetUnreachable

func (x *ListFunctionsResponse) GetUnreachable() []string

func (*ListFunctionsResponse) ProtoMessage

func (*ListFunctionsResponse) ProtoMessage()

func (*ListFunctionsResponse) ProtoReflect

func (x *ListFunctionsResponse) ProtoReflect() protoreflect.Message

func (*ListFunctionsResponse) Reset

func (x *ListFunctionsResponse) Reset()

func (*ListFunctionsResponse) String

func (x *ListFunctionsResponse) String() string

type OperationMetadataV1Beta2

type OperationMetadataV1Beta2 struct {

	// Target of the operation - for example
	// projects/project-1/locations/region-1/functions/function-1
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// Type of operation.
	Type OperationType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.functions.v1beta2.OperationType" json:"type,omitempty"`
	// The original request that started the operation.
	Request *any.Any `protobuf:"bytes,3,opt,name=request,proto3" json:"request,omitempty"`
	// Version id of the function created or updated by an API call.
	// This field is only populated for Create and Update operations.
	VersionId int64 `protobuf:"varint,4,opt,name=version_id,json=versionId,proto3" json:"version_id,omitempty"`
	// The last update timestamp of the operation.
	UpdateTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata describing an [Operation][google.longrunning.Operation]

func (*OperationMetadataV1Beta2) Descriptor deprecated

func (*OperationMetadataV1Beta2) Descriptor() ([]byte, []int)

Deprecated: Use OperationMetadataV1Beta2.ProtoReflect.Descriptor instead.

func (*OperationMetadataV1Beta2) GetRequest

func (x *OperationMetadataV1Beta2) GetRequest() *any.Any

func (*OperationMetadataV1Beta2) GetTarget

func (x *OperationMetadataV1Beta2) GetTarget() string

func (*OperationMetadataV1Beta2) GetType

func (*OperationMetadataV1Beta2) GetUpdateTime

func (x *OperationMetadataV1Beta2) GetUpdateTime() *timestamp.Timestamp

func (*OperationMetadataV1Beta2) GetVersionId

func (x *OperationMetadataV1Beta2) GetVersionId() int64

func (*OperationMetadataV1Beta2) ProtoMessage

func (*OperationMetadataV1Beta2) ProtoMessage()

func (*OperationMetadataV1Beta2) ProtoReflect

func (x *OperationMetadataV1Beta2) ProtoReflect() protoreflect.Message

func (*OperationMetadataV1Beta2) Reset

func (x *OperationMetadataV1Beta2) Reset()

func (*OperationMetadataV1Beta2) String

func (x *OperationMetadataV1Beta2) String() string

type OperationType

type OperationType int32

A type of an operation.

const (
	// Unknown operation type.
	OperationType_OPERATION_UNSPECIFIED OperationType = 0
	// Triggered by CreateFunction call
	OperationType_CREATE_FUNCTION OperationType = 1
	// Triggered by UpdateFunction call
	OperationType_UPDATE_FUNCTION OperationType = 2
	// Triggered by DeleteFunction call.
	OperationType_DELETE_FUNCTION OperationType = 3
)

func (OperationType) Descriptor

func (OperationType) Enum

func (x OperationType) Enum() *OperationType

func (OperationType) EnumDescriptor deprecated

func (OperationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationType.Descriptor instead.

func (OperationType) Number

func (OperationType) String

func (x OperationType) String() string

func (OperationType) Type

type SourceRepository

type SourceRepository struct {

	// URL to the hosted repository where the function is defined. Only paths in
	// https://source.developers.google.com domain are supported. The path should
	// contain the name of the repository.
	RepositoryUrl string `protobuf:"bytes,1,opt,name=repository_url,json=repositoryUrl,proto3" json:"repository_url,omitempty"`
	// The path within the repository where the function is defined. The path
	// should point to the directory where Cloud Functions files are located. Use
	// "/" if the function is defined directly in the root directory of a
	// repository.
	SourcePath string `protobuf:"bytes,2,opt,name=source_path,json=sourcePath,proto3" json:"source_path,omitempty"`
	// The version of a function. Defaults to the latest version of the master
	// branch.
	//
	// Types that are assignable to Version:
	//	*SourceRepository_Branch
	//	*SourceRepository_Tag
	//	*SourceRepository_Revision
	Version isSourceRepository_Version `protobuf_oneof:"version"`
	// Output only. The id of the revision that was resolved at the moment of
	// function creation or update. For example when a user deployed from a
	// branch, it will be the revision id of the latest change on this branch at
	// that time. If user deployed from revision then this value will be always
	// equal to the revision specified by the user.
	DeployedRevision string `protobuf:"bytes,6,opt,name=deployed_revision,json=deployedRevision,proto3" json:"deployed_revision,omitempty"`
	// contains filtered or unexported fields
}

Describes the location of the function source in a remote repository.

func (*SourceRepository) Descriptor deprecated

func (*SourceRepository) Descriptor() ([]byte, []int)

Deprecated: Use SourceRepository.ProtoReflect.Descriptor instead.

func (*SourceRepository) GetBranch

func (x *SourceRepository) GetBranch() string

func (*SourceRepository) GetDeployedRevision

func (x *SourceRepository) GetDeployedRevision() string

func (*SourceRepository) GetRepositoryUrl

func (x *SourceRepository) GetRepositoryUrl() string

func (*SourceRepository) GetRevision

func (x *SourceRepository) GetRevision() string

func (*SourceRepository) GetSourcePath

func (x *SourceRepository) GetSourcePath() string

func (*SourceRepository) GetTag

func (x *SourceRepository) GetTag() string

func (*SourceRepository) GetVersion

func (m *SourceRepository) GetVersion() isSourceRepository_Version

func (*SourceRepository) ProtoMessage

func (*SourceRepository) ProtoMessage()

func (*SourceRepository) ProtoReflect

func (x *SourceRepository) ProtoReflect() protoreflect.Message

func (*SourceRepository) Reset

func (x *SourceRepository) Reset()

func (*SourceRepository) String

func (x *SourceRepository) String() string

type SourceRepository_Branch

type SourceRepository_Branch struct {
	// The name of the branch from which the function should be fetched.
	Branch string `protobuf:"bytes,3,opt,name=branch,proto3,oneof"`
}

type SourceRepository_Revision

type SourceRepository_Revision struct {
	// The id of the revision that captures the state of the repository from
	// which the function should be fetched.
	Revision string `protobuf:"bytes,5,opt,name=revision,proto3,oneof"`
}

type SourceRepository_Tag

type SourceRepository_Tag struct {
	// The name of the tag that captures the state of the repository from
	// which the function should be fetched.
	Tag string `protobuf:"bytes,4,opt,name=tag,proto3,oneof"`
}

type UnimplementedCloudFunctionsServiceServer

type UnimplementedCloudFunctionsServiceServer struct {
}

UnimplementedCloudFunctionsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCloudFunctionsServiceServer) CallFunction

func (*UnimplementedCloudFunctionsServiceServer) CreateFunction

func (*UnimplementedCloudFunctionsServiceServer) DeleteFunction

func (*UnimplementedCloudFunctionsServiceServer) GenerateDownloadUrl

func (*UnimplementedCloudFunctionsServiceServer) GenerateUploadUrl

func (*UnimplementedCloudFunctionsServiceServer) GetFunction

func (*UnimplementedCloudFunctionsServiceServer) ListFunctions

func (*UnimplementedCloudFunctionsServiceServer) UpdateFunction

type UpdateFunctionRequest

type UpdateFunctionRequest struct {

	// Required. The name of the function to be updated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. New version of the function.
	Function *CloudFunction `protobuf:"bytes,2,opt,name=function,proto3" json:"function,omitempty"`
	// contains filtered or unexported fields
}

Request for the `UpdateFunction` method.

func (*UpdateFunctionRequest) Descriptor deprecated

func (*UpdateFunctionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateFunctionRequest.ProtoReflect.Descriptor instead.

func (*UpdateFunctionRequest) GetFunction

func (x *UpdateFunctionRequest) GetFunction() *CloudFunction

func (*UpdateFunctionRequest) GetName

func (x *UpdateFunctionRequest) GetName() string

func (*UpdateFunctionRequest) ProtoMessage

func (*UpdateFunctionRequest) ProtoMessage()

func (*UpdateFunctionRequest) ProtoReflect

func (x *UpdateFunctionRequest) ProtoReflect() protoreflect.Message

func (*UpdateFunctionRequest) Reset

func (x *UpdateFunctionRequest) Reset()

func (*UpdateFunctionRequest) String

func (x *UpdateFunctionRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL