functions

package
Version: v0.0.0-...-508584e Latest Latest
Warning

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

Go to latest
Published: May 24, 2022 License: Apache-2.0 Imports: 15 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	CloudFunctionStatus_name = map[int32]string{
		0: "CLOUD_FUNCTION_STATUS_UNSPECIFIED",
		1: "ACTIVE",
		2: "OFFLINE",
		3: "DEPLOY_IN_PROGRESS",
		4: "DELETE_IN_PROGRESS",
		5: "UNKNOWN",
	}
	CloudFunctionStatus_value = map[string]int32{
		"CLOUD_FUNCTION_STATUS_UNSPECIFIED": 0,
		"ACTIVE":                            1,
		"OFFLINE":                           2,
		"DEPLOY_IN_PROGRESS":                3,
		"DELETE_IN_PROGRESS":                4,
		"UNKNOWN":                           5,
	}
)

Enum value maps for CloudFunctionStatus.

View Source
var (
	CloudFunction_VpcConnectorEgressSettings_name = map[int32]string{
		0: "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED",
		1: "PRIVATE_RANGES_ONLY",
		2: "ALL_TRAFFIC",
	}
	CloudFunction_VpcConnectorEgressSettings_value = map[string]int32{
		"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED": 0,
		"PRIVATE_RANGES_ONLY":                       1,
		"ALL_TRAFFIC":                               2,
	}
)

Enum value maps for CloudFunction_VpcConnectorEgressSettings.

View Source
var (
	CloudFunction_IngressSettings_name = map[int32]string{
		0: "INGRESS_SETTINGS_UNSPECIFIED",
		1: "ALLOW_ALL",
		2: "ALLOW_INTERNAL_ONLY",
		3: "ALLOW_INTERNAL_AND_GCLB",
	}
	CloudFunction_IngressSettings_value = map[string]int32{
		"INGRESS_SETTINGS_UNSPECIFIED": 0,
		"ALLOW_ALL":                    1,
		"ALLOW_INTERNAL_ONLY":          2,
		"ALLOW_INTERNAL_AND_GCLB":      3,
	}
)

Enum value maps for CloudFunction_IngressSettings.

View Source
var (
	HttpsTrigger_SecurityLevel_name = map[int32]string{
		0: "SECURITY_LEVEL_UNSPECIFIED",
		1: "SECURE_ALWAYS",
		2: "SECURE_OPTIONAL",
	}
	HttpsTrigger_SecurityLevel_value = map[string]int32{
		"SECURITY_LEVEL_UNSPECIFIED": 0,
		"SECURE_ALWAYS":              1,
		"SECURE_OPTIONAL":            2,
	}
)

Enum value maps for HttpsTrigger_SecurityLevel.

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_v1_functions_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_functions_v1_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"`
	// User-provided description of a function.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// The location of the function source code.
	//
	// Types that are assignable to SourceCode:
	//	*CloudFunction_SourceArchiveUrl
	//	*CloudFunction_SourceRepository
	//	*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.v1.CloudFunctionStatus" json:"status,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,8,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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
	Runtime string `protobuf:"bytes,19,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 *durationpb.Duration `protobuf:"bytes,9,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// The amount of memory in MB available for a function.
	// Defaults to 256MB.
	AvailableMemoryMb int32 `protobuf:"varint,10,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`.
	ServiceAccountEmail string `protobuf:"bytes,11,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// Output only. The last update timestamp of a Cloud Function.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,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,14,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 */
	// Build environment variables that shall be available during build time.
	BuildEnvironmentVariables map[string]string `` /* 227-byte string literal not displayed */
	// 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,18,opt,name=network,proto3" json:"network,omitempty"`
	// 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](https://cloud.google.com/functions/docs/max-instances) Guide for
	// more details.
	MaxInstances int32 `protobuf:"varint,20,opt,name=max_instances,json=maxInstances,proto3" json:"max_instances,omitempty"`
	// A lower bound for the number function instances that may coexist at a
	// given time.
	MinInstances int32 `protobuf:"varint,32,opt,name=min_instances,json=minInstances,proto3" json:"min_instances,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,22,opt,name=vpc_connector,json=vpcConnector,proto3" json:"vpc_connector,omitempty"`
	// The egress settings for the connector, controlling what traffic is diverted
	// through it.
	VpcConnectorEgressSettings CloudFunction_VpcConnectorEgressSettings `` /* 217-byte string literal not displayed */
	// The ingress settings for the function, controlling what traffic can reach
	// it.
	IngressSettings CloudFunction_IngressSettings `` /* 169-byte string literal not displayed */
	// Resource name of a KMS crypto key (managed by the user) used to
	// encrypt/decrypt function resources.
	//
	// It must match the pattern
	// `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	//
	// If specified, you must also provide an artifact registry repository using
	// the `docker_repository` field that was created with the same KMS crypto
	// key.
	//
	// The following service accounts need to be granted Cloud KMS crypto key
	// encrypter/decrypter roles on the key.
	//
	// 1. Google Cloud Functions service account
	//    (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) -
	//    Required to protect the function's image.
	// 2. Google Storage service account
	//    (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) -
	//    Required to protect the function's source code.
	//    If this service account does not exist, deploying a function without a
	//    KMS key or retrieving the service agent name provisions it. For more
	//    information, see
	//    https://cloud.google.com/storage/docs/projects#service-agents and
	//    https://cloud.google.com/storage/docs/getting-service-agent#gsutil.
	//
	// Google Cloud Functions delegates access to service agents to protect
	// function resources in internal projects that are not accessible by the
	// end user.
	KmsKeyName string `protobuf:"bytes,25,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// 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-<project_number>@gcf-admin-robot.iam.gserviceaccount.com`) must
	// be granted the role Cloud Build Custom Workers Builder
	// (`roles/cloudbuild.customworkers.builder`) in the project.
	BuildWorkerPool string `protobuf:"bytes,26,opt,name=build_worker_pool,json=buildWorkerPool,proto3" json:"build_worker_pool,omitempty"`
	// Output only. The Cloud Build ID of the latest successful deployment of the
	// function.
	BuildId string `protobuf:"bytes,27,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"`
	// Output only. The Cloud Build Name of the function deployment.
	// `projects/<project-number>/locations/<region>/builds/<build-id>`.
	BuildName string `protobuf:"bytes,33,opt,name=build_name,json=buildName,proto3" json:"build_name,omitempty"`
	// Secret environment variables configuration.
	SecretEnvironmentVariables []*SecretEnvVar `` /* 142-byte string literal not displayed */
	// Secret volumes configuration.
	SecretVolumes []*SecretVolume `protobuf:"bytes,30,rep,name=secret_volumes,json=secretVolumes,proto3" json:"secret_volumes,omitempty"`
	// Input only. An identifier for Firebase function sources. Disclaimer: This field is only
	// supported for Firebase function deployments.
	SourceToken string `protobuf:"bytes,31,opt,name=source_token,json=sourceToken,proto3" json:"source_token,omitempty"`
	// User managed repository created in Artifact Registry optionally with a
	// customer managed encryption key. If specified, deployments will use
	// Artifact Registry. If unspecified and the deployment is eligible to use
	// Artifact Registry, GCF will create and use a repository named
	// 'gcf-artifacts' for every deployed region. This is the repository to which
	// the function docker image will be pushed after it is built by Cloud Build.
	//
	// It must match the pattern
	// `projects/{project}/locations/{location}/repositories/{repository}`.
	//
	// Cross-project repositories are not supported.
	// Cross-location repositories are not supported.
	// Repository format must be 'DOCKER'.
	DockerRepository string `protobuf:"bytes,34,opt,name=docker_repository,json=dockerRepository,proto3" json:"docker_repository,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. Next tag: 36

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) GetBuildEnvironmentVariables

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

func (*CloudFunction) GetBuildId

func (x *CloudFunction) GetBuildId() string

func (*CloudFunction) GetBuildName

func (x *CloudFunction) GetBuildName() string

func (*CloudFunction) GetBuildWorkerPool

func (x *CloudFunction) GetBuildWorkerPool() string

func (*CloudFunction) GetDescription

func (x *CloudFunction) GetDescription() string

func (*CloudFunction) GetDockerRepository

func (x *CloudFunction) GetDockerRepository() string

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) GetIngressSettings

func (x *CloudFunction) GetIngressSettings() CloudFunction_IngressSettings

func (*CloudFunction) GetKmsKeyName

func (x *CloudFunction) GetKmsKeyName() string

func (*CloudFunction) GetLabels

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

func (*CloudFunction) GetMaxInstances

func (x *CloudFunction) GetMaxInstances() int32

func (*CloudFunction) GetMinInstances

func (x *CloudFunction) GetMinInstances() 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) GetSecretEnvironmentVariables

func (x *CloudFunction) GetSecretEnvironmentVariables() []*SecretEnvVar

func (*CloudFunction) GetSecretVolumes

func (x *CloudFunction) GetSecretVolumes() []*SecretVolume

func (*CloudFunction) GetServiceAccountEmail

func (x *CloudFunction) GetServiceAccountEmail() 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) GetSourceToken

func (x *CloudFunction) GetSourceToken() string

func (*CloudFunction) GetSourceUploadUrl

func (x *CloudFunction) GetSourceUploadUrl() string

func (*CloudFunction) GetStatus

func (x *CloudFunction) GetStatus() CloudFunctionStatus

func (*CloudFunction) GetTimeout

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

func (*CloudFunction) GetTrigger

func (m *CloudFunction) GetTrigger() isCloudFunction_Trigger

func (*CloudFunction) GetUpdateTime

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

func (*CloudFunction) GetVersionId

func (x *CloudFunction) GetVersionId() int64

func (*CloudFunction) GetVpcConnector

func (x *CloudFunction) GetVpcConnector() string

func (*CloudFunction) GetVpcConnectorEgressSettings

func (x *CloudFunction) GetVpcConnectorEgressSettings() CloudFunction_VpcConnectorEgressSettings

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 (
	// Not specified. Invalid state.
	CloudFunctionStatus_CLOUD_FUNCTION_STATUS_UNSPECIFIED CloudFunctionStatus = 0
	// Function has been successfully deployed and is serving.
	CloudFunctionStatus_ACTIVE CloudFunctionStatus = 1
	// Function deployment failed and the function isn’t serving.
	CloudFunctionStatus_OFFLINE CloudFunctionStatus = 2
	// Function is being created or updated.
	CloudFunctionStatus_DEPLOY_IN_PROGRESS CloudFunctionStatus = 3
	// Function is being deleted.
	CloudFunctionStatus_DELETE_IN_PROGRESS CloudFunctionStatus = 4
	// Function deployment failed and the function serving state is undefined.
	// The function should be updated or deleted to move it out of this state.
	CloudFunctionStatus_UNKNOWN CloudFunctionStatus = 5
)

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,6,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,5,opt,name=https_trigger,json=httpsTrigger,proto3,oneof"`
}

type CloudFunction_IngressSettings

type CloudFunction_IngressSettings int32

Available ingress settings.

This controls what traffic can reach the function.

If unspecified, ALLOW_ALL will be used.

const (
	// Unspecified.
	CloudFunction_INGRESS_SETTINGS_UNSPECIFIED CloudFunction_IngressSettings = 0
	// Allow HTTP traffic from public and private sources.
	CloudFunction_ALLOW_ALL CloudFunction_IngressSettings = 1
	// Allow HTTP traffic from only private VPC sources.
	CloudFunction_ALLOW_INTERNAL_ONLY CloudFunction_IngressSettings = 2
	// Allow HTTP traffic from private VPC sources and through GCLB.
	CloudFunction_ALLOW_INTERNAL_AND_GCLB CloudFunction_IngressSettings = 3
)

func (CloudFunction_IngressSettings) Descriptor

func (CloudFunction_IngressSettings) Enum

func (CloudFunction_IngressSettings) EnumDescriptor deprecated

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

Deprecated: Use CloudFunction_IngressSettings.Descriptor instead.

func (CloudFunction_IngressSettings) Number

func (CloudFunction_IngressSettings) String

func (CloudFunction_IngressSettings) Type

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,3,opt,name=source_archive_url,json=sourceArchiveUrl,proto3,oneof"`
}

type CloudFunction_SourceRepository

type CloudFunction_SourceRepository struct {
	// **Beta Feature**
	//
	// The source repository where a function is hosted.
	SourceRepository *SourceRepository `protobuf:"bytes,4,opt,name=source_repository,json=sourceRepository,proto3,oneof"`
}

type CloudFunction_SourceUploadUrl

type CloudFunction_SourceUploadUrl struct {
	// The Google Cloud Storage signed URL used for source uploading, generated
	// by calling [google.cloud.functions.v1.GenerateUploadUrl].
	//
	// The signature is validated on write methods (Create, Update)
	// The signature is stripped from the Function object on read methods (Get,
	// List)
	SourceUploadUrl string `protobuf:"bytes,16,opt,name=source_upload_url,json=sourceUploadUrl,proto3,oneof"`
}

type CloudFunction_VpcConnectorEgressSettings

type CloudFunction_VpcConnectorEgressSettings int32

Available egress settings.

This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.

const (
	// Unspecified.
	CloudFunction_VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED CloudFunction_VpcConnectorEgressSettings = 0
	// Use the VPC Access Connector only for private IP space from RFC1918.
	CloudFunction_PRIVATE_RANGES_ONLY CloudFunction_VpcConnectorEgressSettings = 1
	// Force the use of VPC Access Connector for all egress traffic from the
	// function.
	CloudFunction_ALL_TRAFFIC CloudFunction_VpcConnectorEgressSettings = 2
)

func (CloudFunction_VpcConnectorEgressSettings) Descriptor

func (CloudFunction_VpcConnectorEgressSettings) Enum

func (CloudFunction_VpcConnectorEgressSettings) EnumDescriptor deprecated

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

Deprecated: Use CloudFunction_VpcConnectorEgressSettings.Descriptor instead.

func (CloudFunction_VpcConnectorEgressSettings) Number

func (CloudFunction_VpcConnectorEgressSettings) String

func (CloudFunction_VpcConnectorEgressSettings) Type

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
	// [Rate Limits](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)
	// Sets the IAM access control policy on the specified function.
	// Replaces any existing policy.
	SetIamPolicy(ctx context.Context, in *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
	// Gets the IAM access control policy for a function.
	// Returns an empty policy if the function exists and does not have a policy
	// set.
	GetIamPolicy(ctx context.Context, in *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
	// Tests the specified permissions against the IAM access control policy
	// for a function.
	// If the function does not exist, this will return an empty set of
	// permissions, not a NOT_FOUND error.
	TestIamPermissions(ctx context.Context, in *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, 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
	// [Rate Limits](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)
	// Sets the IAM access control policy on the specified function.
	// Replaces any existing policy.
	SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
	// Gets the IAM access control policy for a function.
	// Returns an empty policy if the function exists and does not have a policy
	// set.
	GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
	// Tests the specified permissions against the IAM access control policy
	// for a function.
	// If the function does not exist, this will return an empty set of
	// permissions, not a NOT_FOUND error.
	TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, 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 {

	// Required. The type of event to observe. For example:
	// `providers/cloud.storage/eventTypes/object.change` and
	// `providers/cloud.pubsub/eventTypes/topic.publish`.
	//
	// Event types match pattern `providers/*/eventTypes/*.*`.
	// The pattern contains:
	//
	// 1. namespace: For example, `cloud.storage` and
	//    `google.firebase.analytics`.
	// 2. resource type: The type of resource on which event occurs. For
	//    example, the Google Cloud Storage API includes the type `object`.
	// 3. action: The action that generates the event. For example, action for
	//    a Google Cloud Storage Object is 'change'.
	// These parts are lower case.
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Required. The resource(s) from which to observe events, for example,
	// `projects/_/buckets/myBucket`.
	//
	// Not all syntactically correct values are accepted by all services. For
	// example:
	//
	// 1. The authorization model must support it. Google Cloud Functions
	//    only allows EventTriggers to be deployed that observe resources in the
	//    same project as the `CloudFunction`.
	// 2. The resource type must match the pattern expected for an
	//    `event_type`. For example, an `EventTrigger` that has an
	//    `event_type` of "google.pubsub.topic.publish" should have a resource
	//    that matches Google Cloud Pub/Sub topics.
	//
	// Additionally, some services may support short names when creating an
	// `EventTrigger`. These will always be returned in the normalized "long"
	// format.
	//
	// See each *service's* documentation for supported formats.
	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,3,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. If not set, default, current version
	// is used.
	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 `GenerateSourceUploadUrl` 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 `GenerateSourceUploadUrl` 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"`
	// The security level for the function.
	SecurityLevel HttpsTrigger_SecurityLevel `` /* 159-byte string literal not displayed */
	// 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) GetSecurityLevel

func (x *HttpsTrigger) GetSecurityLevel() HttpsTrigger_SecurityLevel

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 HttpsTrigger_SecurityLevel

type HttpsTrigger_SecurityLevel int32

Available security level settings.

This controls the methods to enforce security (HTTPS) on a URL.

If unspecified, SECURE_OPTIONAL will be used.

const (
	// Unspecified.
	HttpsTrigger_SECURITY_LEVEL_UNSPECIFIED HttpsTrigger_SecurityLevel = 0
	// Requests for a URL that match this handler that do not use HTTPS are
	// automatically redirected to the HTTPS URL with the same path. Query
	// parameters are reserved for the redirect.
	HttpsTrigger_SECURE_ALWAYS HttpsTrigger_SecurityLevel = 1
	// Both HTTP and HTTPS requests with URLs that match the handler succeed
	// without redirects. The application can examine the request to determine
	// which protocol was used and respond accordingly.
	HttpsTrigger_SECURE_OPTIONAL HttpsTrigger_SecurityLevel = 2
)

func (HttpsTrigger_SecurityLevel) Descriptor

func (HttpsTrigger_SecurityLevel) Enum

func (HttpsTrigger_SecurityLevel) EnumDescriptor deprecated

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

Deprecated: Use HttpsTrigger_SecurityLevel.Descriptor instead.

func (HttpsTrigger_SecurityLevel) Number

func (HttpsTrigger_SecurityLevel) String

func (HttpsTrigger_SecurityLevel) Type

type ListFunctionsRequest

type ListFunctionsRequest struct {

	// 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.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,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) GetPageSize

func (x *ListFunctionsRequest) GetPageSize() int32

func (*ListFunctionsRequest) GetPageToken

func (x *ListFunctionsRequest) GetPageToken() string

func (*ListFunctionsRequest) GetParent

func (x *ListFunctionsRequest) GetParent() 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.v1.ListFunctionsRequest][google.cloud.functions.v1.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 OperationMetadataV1

type OperationMetadataV1 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.v1.OperationType" json:"type,omitempty"`
	// The original request that started the operation.
	Request *anypb.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 *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The Cloud Build ID of the function created or updated by an API call.
	// This field is only populated for Create and Update operations.
	BuildId string `protobuf:"bytes,6,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"`
	// An identifier for Firebase function sources. Disclaimer: This field is only
	// supported for Firebase function deployments.
	SourceToken string `protobuf:"bytes,7,opt,name=source_token,json=sourceToken,proto3" json:"source_token,omitempty"`
	// The Cloud Build Name of the function deployment.
	// This field is only populated for Create and Update operations.
	// `projects/<project-number>/locations/<region>/builds/<build-id>`.
	BuildName string `protobuf:"bytes,8,opt,name=build_name,json=buildName,proto3" json:"build_name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*OperationMetadataV1) Descriptor deprecated

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

Deprecated: Use OperationMetadataV1.ProtoReflect.Descriptor instead.

func (*OperationMetadataV1) GetBuildId

func (x *OperationMetadataV1) GetBuildId() string

func (*OperationMetadataV1) GetBuildName

func (x *OperationMetadataV1) GetBuildName() string

func (*OperationMetadataV1) GetRequest

func (x *OperationMetadataV1) GetRequest() *anypb.Any

func (*OperationMetadataV1) GetSourceToken

func (x *OperationMetadataV1) GetSourceToken() string

func (*OperationMetadataV1) GetTarget

func (x *OperationMetadataV1) GetTarget() string

func (*OperationMetadataV1) GetType

func (x *OperationMetadataV1) GetType() OperationType

func (*OperationMetadataV1) GetUpdateTime

func (x *OperationMetadataV1) GetUpdateTime() *timestamppb.Timestamp

func (*OperationMetadataV1) GetVersionId

func (x *OperationMetadataV1) GetVersionId() int64

func (*OperationMetadataV1) ProtoMessage

func (*OperationMetadataV1) ProtoMessage()

func (*OperationMetadataV1) ProtoReflect

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

func (*OperationMetadataV1) Reset

func (x *OperationMetadataV1) Reset()

func (*OperationMetadataV1) String

func (x *OperationMetadataV1) 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 SecretEnvVar

type SecretEnvVar struct {

	// Name of the environment variable.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Project identifier (preferrably project number but can also be the project
	// ID) of the project that contains the secret. If not set, it will be
	// populated with the function's project assuming that the secret exists in
	// the same project as of the function.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Name of the secret in secret manager (not the full resource name).
	Secret string `protobuf:"bytes,3,opt,name=secret,proto3" json:"secret,omitempty"`
	// Version of the secret (version number or the string 'latest'). It is
	// recommended to use a numeric version for secret environment variables as
	// any updates to the secret value is not reflected until new clones start.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable. Secret value is not a part of the configuration. Secret values are only fetched when a new clone starts.

func (*SecretEnvVar) Descriptor deprecated

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

Deprecated: Use SecretEnvVar.ProtoReflect.Descriptor instead.

func (*SecretEnvVar) GetKey

func (x *SecretEnvVar) GetKey() string

func (*SecretEnvVar) GetProjectId

func (x *SecretEnvVar) GetProjectId() string

func (*SecretEnvVar) GetSecret

func (x *SecretEnvVar) GetSecret() string

func (*SecretEnvVar) GetVersion

func (x *SecretEnvVar) GetVersion() string

func (*SecretEnvVar) ProtoMessage

func (*SecretEnvVar) ProtoMessage()

func (*SecretEnvVar) ProtoReflect

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

func (*SecretEnvVar) Reset

func (x *SecretEnvVar) Reset()

func (*SecretEnvVar) String

func (x *SecretEnvVar) String() string

type SecretVolume

type SecretVolume struct {

	// The path within the container to mount the secret volume. For example,
	// setting the mount_path as `/etc/secrets` would mount the secret value files
	// under the `/etc/secrets` directory. This directory will also be completely
	// shadowed and unavailable to mount any other secrets.
	//
	// Recommended mount paths: /etc/secrets
	// Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
	MountPath string `protobuf:"bytes,1,opt,name=mount_path,json=mountPath,proto3" json:"mount_path,omitempty"`
	// Project identifier (preferrably project number but can also be the project
	// ID) of the project that contains the secret. If not set, it will be
	// populated with the function's project assuming that the secret exists in
	// the same project as of the function.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Name of the secret in secret manager (not the full resource name).
	Secret string `protobuf:"bytes,3,opt,name=secret,proto3" json:"secret,omitempty"`
	// List of secret versions to mount for this secret. If empty, the `latest`
	// version of the secret will be made available in a file named after the
	// secret under the mount point.
	Versions []*SecretVolume_SecretVersion `protobuf:"bytes,4,rep,name=versions,proto3" json:"versions,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.

func (*SecretVolume) Descriptor deprecated

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

Deprecated: Use SecretVolume.ProtoReflect.Descriptor instead.

func (*SecretVolume) GetMountPath

func (x *SecretVolume) GetMountPath() string

func (*SecretVolume) GetProjectId

func (x *SecretVolume) GetProjectId() string

func (*SecretVolume) GetSecret

func (x *SecretVolume) GetSecret() string

func (*SecretVolume) GetVersions

func (x *SecretVolume) GetVersions() []*SecretVolume_SecretVersion

func (*SecretVolume) ProtoMessage

func (*SecretVolume) ProtoMessage()

func (*SecretVolume) ProtoReflect

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

func (*SecretVolume) Reset

func (x *SecretVolume) Reset()

func (*SecretVolume) String

func (x *SecretVolume) String() string

type SecretVolume_SecretVersion

type SecretVolume_SecretVersion struct {

	// Version of the secret (version number or the string 'latest'). It is
	// preferrable to use `latest` version with secret volumes as secret value
	// changes are reflected immediately.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Relative path of the file under the mount path where the secret value for
	// this version will be fetched and made available. For example, setting the
	// mount_path as '/etc/secrets' and path as `/secret_foo` would mount the
	// secret value file at `/etc/secrets/secret_foo`.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a single version.

func (*SecretVolume_SecretVersion) Descriptor deprecated

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

Deprecated: Use SecretVolume_SecretVersion.ProtoReflect.Descriptor instead.

func (*SecretVolume_SecretVersion) GetPath

func (x *SecretVolume_SecretVersion) GetPath() string

func (*SecretVolume_SecretVersion) GetVersion

func (x *SecretVolume_SecretVersion) GetVersion() string

func (*SecretVolume_SecretVersion) ProtoMessage

func (*SecretVolume_SecretVersion) ProtoMessage()

func (*SecretVolume_SecretVersion) ProtoReflect

func (*SecretVolume_SecretVersion) Reset

func (x *SecretVolume_SecretVersion) Reset()

func (*SecretVolume_SecretVersion) String

func (x *SecretVolume_SecretVersion) String() string

type SourceRepository

type SourceRepository 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.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// Output only. The URL pointing to the hosted repository where the function
	// were defined at the time of deployment. It always points to a specific
	// commit in the format described above.
	DeployedUrl string `protobuf:"bytes,2,opt,name=deployed_url,json=deployedUrl,proto3" json:"deployed_url,omitempty"`
	// contains filtered or unexported fields
}

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.

func (*SourceRepository) Descriptor deprecated

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

Deprecated: Use SourceRepository.ProtoReflect.Descriptor instead.

func (*SourceRepository) GetDeployedUrl

func (x *SourceRepository) GetDeployedUrl() string

func (*SourceRepository) GetUrl

func (x *SourceRepository) GetUrl() string

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 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) GetIamPolicy

func (*UnimplementedCloudFunctionsServiceServer) ListFunctions

func (*UnimplementedCloudFunctionsServiceServer) SetIamPolicy

func (*UnimplementedCloudFunctionsServiceServer) TestIamPermissions

func (*UnimplementedCloudFunctionsServiceServer) UpdateFunction

type UpdateFunctionRequest

type UpdateFunctionRequest struct {

	// Required. New version of the function.
	Function *CloudFunction `protobuf:"bytes,1,opt,name=function,proto3" json:"function,omitempty"`
	// Required list of fields to be updated in this request.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,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) GetUpdateMask

func (x *UpdateFunctionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

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