Enum value maps for Environment.
var (
Environment_name = map[int32]string{
0: "ENVIRONMENT_UNSPECIFIED",
1: "GEN_1",
2: "GEN_2",
}
Environment_value = map[string]int32{
"ENVIRONMENT_UNSPECIFIED": 0,
"GEN_1": 1,
"GEN_2": 2,
}
)
Enum value maps for Function_State.
var (
Function_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "FAILED",
3: "DEPLOYING",
4: "DELETING",
5: "UNKNOWN",
}
Function_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"FAILED": 2,
"DEPLOYING": 3,
"DELETING": 4,
"UNKNOWN": 5,
}
)
Enum value maps for StateMessage_Severity.
var (
StateMessage_Severity_name = map[int32]string{
0: "SEVERITY_UNSPECIFIED",
1: "ERROR",
2: "WARNING",
3: "INFO",
}
StateMessage_Severity_value = map[string]int32{
"SEVERITY_UNSPECIFIED": 0,
"ERROR": 1,
"WARNING": 2,
"INFO": 3,
}
)
Enum value maps for ServiceConfig_VpcConnectorEgressSettings.
var (
ServiceConfig_VpcConnectorEgressSettings_name = map[int32]string{
0: "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED",
1: "PRIVATE_RANGES_ONLY",
2: "ALL_TRAFFIC",
}
ServiceConfig_VpcConnectorEgressSettings_value = map[string]int32{
"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED": 0,
"PRIVATE_RANGES_ONLY": 1,
"ALL_TRAFFIC": 2,
}
)
Enum value maps for ServiceConfig_IngressSettings.
var (
ServiceConfig_IngressSettings_name = map[int32]string{
0: "INGRESS_SETTINGS_UNSPECIFIED",
1: "ALLOW_ALL",
2: "ALLOW_INTERNAL_ONLY",
3: "ALLOW_INTERNAL_AND_GCLB",
}
ServiceConfig_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 EventTrigger_RetryPolicy.
var (
EventTrigger_RetryPolicy_name = map[int32]string{
0: "RETRY_POLICY_UNSPECIFIED",
1: "RETRY_POLICY_DO_NOT_RETRY",
2: "RETRY_POLICY_RETRY",
}
EventTrigger_RetryPolicy_value = map[string]int32{
"RETRY_POLICY_UNSPECIFIED": 0,
"RETRY_POLICY_DO_NOT_RETRY": 1,
"RETRY_POLICY_RETRY": 2,
}
)
Enum value maps for ListRuntimesResponse_RuntimeStage.
var (
ListRuntimesResponse_RuntimeStage_name = map[int32]string{
0: "RUNTIME_STAGE_UNSPECIFIED",
1: "DEVELOPMENT",
2: "ALPHA",
3: "BETA",
4: "GA",
5: "DEPRECATED",
6: "DECOMMISSIONED",
}
ListRuntimesResponse_RuntimeStage_value = map[string]int32{
"RUNTIME_STAGE_UNSPECIFIED": 0,
"DEVELOPMENT": 1,
"ALPHA": 2,
"BETA": 3,
"GA": 4,
"DEPRECATED": 5,
"DECOMMISSIONED": 6,
}
)
Enum value maps for Stage_Name.
var (
Stage_Name_name = map[int32]string{
0: "NAME_UNSPECIFIED",
1: "ARTIFACT_REGISTRY",
2: "BUILD",
3: "SERVICE",
4: "TRIGGER",
5: "SERVICE_ROLLBACK",
6: "TRIGGER_ROLLBACK",
}
Stage_Name_value = map[string]int32{
"NAME_UNSPECIFIED": 0,
"ARTIFACT_REGISTRY": 1,
"BUILD": 2,
"SERVICE": 3,
"TRIGGER": 4,
"SERVICE_ROLLBACK": 5,
"TRIGGER_ROLLBACK": 6,
}
)
Enum value maps for Stage_State.
var (
Stage_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "NOT_STARTED",
2: "IN_PROGRESS",
3: "COMPLETE",
}
Stage_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"NOT_STARTED": 1,
"IN_PROGRESS": 2,
"COMPLETE": 3,
}
)
var File_google_cloud_functions_v2alpha_functions_proto protoreflect.FileDescriptor
func RegisterFunctionServiceServer(s *grpc.Server, srv FunctionServiceServer)
Describes the Build step of the function that builds a container from the given source.
type BuildConfig struct {
// Output only. The Cloud Build name of the latest successful deployment of the
// function.
Build string `protobuf:"bytes,1,opt,name=build,proto3" json:"build,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,2,opt,name=runtime,proto3" json:"runtime,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,3,opt,name=entry_point,json=entryPoint,proto3" json:"entry_point,omitempty"`
// The location of the function source code.
Source *Source `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
// Output only. A permanent fixed identifier for source.
SourceProvenance *SourceProvenance `protobuf:"bytes,8,opt,name=source_provenance,json=sourceProvenance,proto3" json:"source_provenance,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.
WorkerPool string `protobuf:"bytes,5,opt,name=worker_pool,json=workerPool,proto3" json:"worker_pool,omitempty"`
// User-provided build-time environment variables for the function
EnvironmentVariables map[string]string `protobuf:"bytes,6,rep,name=environment_variables,json=environmentVariables,proto3" json:"environment_variables,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. User managed repository created in Artifact Registry optionally with a
// customer managed encryption key. This is the repository to which the
// function docker image will be pushed after it is built by Cloud Build.
// If unspecified, GCF will create and use a repository named 'gcf-artifacts'
// for every deployed region.
//
// 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,7,opt,name=docker_repository,json=dockerRepository,proto3" json:"docker_repository,omitempty"`
// contains filtered or unexported fields
}
func (*BuildConfig) Descriptor() ([]byte, []int)
Deprecated: Use BuildConfig.ProtoReflect.Descriptor instead.
func (x *BuildConfig) GetBuild() string
func (x *BuildConfig) GetDockerRepository() string
func (x *BuildConfig) GetEntryPoint() string
func (x *BuildConfig) GetEnvironmentVariables() map[string]string
func (x *BuildConfig) GetRuntime() string
func (x *BuildConfig) GetSource() *Source
func (x *BuildConfig) GetSourceProvenance() *SourceProvenance
func (x *BuildConfig) GetWorkerPool() string
func (*BuildConfig) ProtoMessage()
func (x *BuildConfig) ProtoReflect() protoreflect.Message
func (x *BuildConfig) Reset()
func (x *BuildConfig) String() string
Request for the `CreateFunction` method.
type CreateFunctionRequest struct {
// Required. The project and location in which the function should be created, specified
// in the format `projects/*/locations/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Function to be created.
Function *Function `protobuf:"bytes,2,opt,name=function,proto3" json:"function,omitempty"`
// The ID to use for the function, which will become the final component of
// the function's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-/.
FunctionId string `protobuf:"bytes,3,opt,name=function_id,json=functionId,proto3" json:"function_id,omitempty"`
// contains filtered or unexported fields
}
func (*CreateFunctionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateFunctionRequest.ProtoReflect.Descriptor instead.
func (x *CreateFunctionRequest) GetFunction() *Function
func (x *CreateFunctionRequest) GetFunctionId() string
func (x *CreateFunctionRequest) GetParent() string
func (*CreateFunctionRequest) ProtoMessage()
func (x *CreateFunctionRequest) ProtoReflect() protoreflect.Message
func (x *CreateFunctionRequest) Reset()
func (x *CreateFunctionRequest) String() string
Request for the `DeleteFunction` method.
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
}
func (*DeleteFunctionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFunctionRequest.ProtoReflect.Descriptor instead.
func (x *DeleteFunctionRequest) GetName() string
func (*DeleteFunctionRequest) ProtoMessage()
func (x *DeleteFunctionRequest) ProtoReflect() protoreflect.Message
func (x *DeleteFunctionRequest) Reset()
func (x *DeleteFunctionRequest) String() string
The environment the function is hosted on.
type Environment int32
const (
// Unspecified
Environment_ENVIRONMENT_UNSPECIFIED Environment = 0
// Gen 1
Environment_GEN_1 Environment = 1
// Gen 2
Environment_GEN_2 Environment = 2
)
func (Environment) Descriptor() protoreflect.EnumDescriptor
func (x Environment) Enum() *Environment
func (Environment) EnumDescriptor() ([]byte, []int)
Deprecated: Use Environment.Descriptor instead.
func (x Environment) Number() protoreflect.EnumNumber
func (x Environment) String() string
func (Environment) Type() protoreflect.EnumType
Filters events based on exact matches on the CloudEvents attributes.
type EventFilter struct {
// Required. The name of a CloudEvents attribute.
Attribute string `protobuf:"bytes,1,opt,name=attribute,proto3" json:"attribute,omitempty"`
// Required. The value for the attribute.
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// Optional. The operator used for matching the events with the value of the
// filter. If not specified, only events that have an exact key-value pair
// specified in the filter are matched. The only allowed value is
// `match-path-pattern`.
Operator string `protobuf:"bytes,3,opt,name=operator,proto3" json:"operator,omitempty"`
// contains filtered or unexported fields
}
func (*EventFilter) Descriptor() ([]byte, []int)
Deprecated: Use EventFilter.ProtoReflect.Descriptor instead.
func (x *EventFilter) GetAttribute() string
func (x *EventFilter) GetOperator() string
func (x *EventFilter) GetValue() string
func (*EventFilter) ProtoMessage()
func (x *EventFilter) ProtoReflect() protoreflect.Message
func (x *EventFilter) Reset()
func (x *EventFilter) String() string
Describes EventTrigger, used to request events to be sent from another service.
type EventTrigger struct {
// Output only. The resource name of the Eventarc trigger. The format of this field is
// `projects/{project}/locations/{region}/triggers/{trigger}`.
Trigger string `protobuf:"bytes,1,opt,name=trigger,proto3" json:"trigger,omitempty"`
// The region that the trigger will be in. The trigger will only receive
// events originating in this region. It can be the same
// region as the function, a different region or multi-region, or the global
// region. If not provided, defaults to the same region as the function.
TriggerRegion string `protobuf:"bytes,2,opt,name=trigger_region,json=triggerRegion,proto3" json:"trigger_region,omitempty"`
// Required. The type of event to observe. For example:
// `google.cloud.audit.log.v1.written` or
// `google.cloud.pubsub.topic.v1.messagePublished`.
EventType string `protobuf:"bytes,3,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
// Criteria used to filter events.
EventFilters []*EventFilter `protobuf:"bytes,4,rep,name=event_filters,json=eventFilters,proto3" json:"event_filters,omitempty"`
// Optional. The name of a Pub/Sub topic in the same project that will be used
// as the transport topic for the event delivery. Format:
// `projects/{project}/topics/{topic}`.
//
// This is only valid for events of type
// `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here
// will not be deleted at function deletion.
PubsubTopic string `protobuf:"bytes,5,opt,name=pubsub_topic,json=pubsubTopic,proto3" json:"pubsub_topic,omitempty"`
// Optional. The email of the trigger's service account. The service account must have
// permission to invoke Cloud Run services, the permission is
// `run.routes.invoke`.
// If empty, defaults to the Compute Engine default service account:
// `{project_number}-compute@developer.gserviceaccount.com`.
ServiceAccountEmail string `protobuf:"bytes,6,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
RetryPolicy EventTrigger_RetryPolicy `protobuf:"varint,7,opt,name=retry_policy,json=retryPolicy,proto3,enum=google.cloud.functions.v2alpha.EventTrigger_RetryPolicy" json:"retry_policy,omitempty"`
// Optional. The name of the channel associated with the trigger in
// `projects/{project}/locations/{location}/channels/{channel}` format.
// You must provide a channel to receive events from Eventarc SaaS partners.
Channel string `protobuf:"bytes,8,opt,name=channel,proto3" json:"channel,omitempty"`
// contains filtered or unexported fields
}
func (*EventTrigger) Descriptor() ([]byte, []int)
Deprecated: Use EventTrigger.ProtoReflect.Descriptor instead.
func (x *EventTrigger) GetChannel() string
func (x *EventTrigger) GetEventFilters() []*EventFilter
func (x *EventTrigger) GetEventType() string
func (x *EventTrigger) GetPubsubTopic() string
func (x *EventTrigger) GetRetryPolicy() EventTrigger_RetryPolicy
func (x *EventTrigger) GetServiceAccountEmail() string
func (x *EventTrigger) GetTrigger() string
func (x *EventTrigger) GetTriggerRegion() string
func (*EventTrigger) ProtoMessage()
func (x *EventTrigger) ProtoReflect() protoreflect.Message
func (x *EventTrigger) Reset()
func (x *EventTrigger) String() string
Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.
type EventTrigger_RetryPolicy int32
const (
// Not specified.
EventTrigger_RETRY_POLICY_UNSPECIFIED EventTrigger_RetryPolicy = 0
// Do not retry.
EventTrigger_RETRY_POLICY_DO_NOT_RETRY EventTrigger_RetryPolicy = 1
// Retry on any failure, retry up to 7 days with an exponential backoff
// (capped at 10 seconds).
EventTrigger_RETRY_POLICY_RETRY EventTrigger_RetryPolicy = 2
)
func (EventTrigger_RetryPolicy) Descriptor() protoreflect.EnumDescriptor
func (x EventTrigger_RetryPolicy) Enum() *EventTrigger_RetryPolicy
func (EventTrigger_RetryPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use EventTrigger_RetryPolicy.Descriptor instead.
func (x EventTrigger_RetryPolicy) Number() protoreflect.EnumNumber
func (x EventTrigger_RetryPolicy) String() string
func (EventTrigger_RetryPolicy) Type() protoreflect.EnumType
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
type Function 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"`
// Describe whether the function is gen1 or gen2.
Environment Environment `protobuf:"varint,10,opt,name=environment,proto3,enum=google.cloud.functions.v2alpha.Environment" json:"environment,omitempty"`
// User-provided description of a function.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Describes the Build step of the function that builds a container from the
// given source.
BuildConfig *BuildConfig `protobuf:"bytes,3,opt,name=build_config,json=buildConfig,proto3" json:"build_config,omitempty"`
// Describes the Service being deployed. Currently deploys services to Cloud
// Run (fully managed).
ServiceConfig *ServiceConfig `protobuf:"bytes,4,opt,name=service_config,json=serviceConfig,proto3" json:"service_config,omitempty"`
// An Eventarc trigger managed by Google Cloud Functions that fires events in
// response to a condition in another service.
EventTrigger *EventTrigger `protobuf:"bytes,5,opt,name=event_trigger,json=eventTrigger,proto3" json:"event_trigger,omitempty"`
// Output only. State of the function.
State Function_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.functions.v2alpha.Function_State" json:"state,omitempty"`
// Output only. The last update timestamp of a Cloud Function.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Labels associated with this Cloud Function.
Labels map[string]string `protobuf:"bytes,8,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. State Messages for this Cloud Function.
StateMessages []*StateMessage `protobuf:"bytes,9,rep,name=state_messages,json=stateMessages,proto3" json:"state_messages,omitempty"`
// contains filtered or unexported fields
}
func (*Function) Descriptor() ([]byte, []int)
Deprecated: Use Function.ProtoReflect.Descriptor instead.
func (x *Function) GetBuildConfig() *BuildConfig
func (x *Function) GetDescription() string
func (x *Function) GetEnvironment() Environment
func (x *Function) GetEventTrigger() *EventTrigger
func (x *Function) GetLabels() map[string]string
func (x *Function) GetName() string
func (x *Function) GetServiceConfig() *ServiceConfig
func (x *Function) GetState() Function_State
func (x *Function) GetStateMessages() []*StateMessage
func (x *Function) GetUpdateTime() *timestamppb.Timestamp
func (*Function) ProtoMessage()
func (x *Function) ProtoReflect() protoreflect.Message
func (x *Function) Reset()
func (x *Function) String() string
FunctionServiceClient is the client API for FunctionService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type FunctionServiceClient interface {
// Returns a function with the given name from the requested project.
GetFunction(ctx context.Context, in *GetFunctionRequest, opts ...grpc.CallOption) (*Function, error)
// Returns a list of functions that belong to the requested project.
ListFunctions(ctx context.Context, in *ListFunctionsRequest, opts ...grpc.CallOption) (*ListFunctionsResponse, 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)
// 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.
// * 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`
//
// 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
// 30 minutes of 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)
// Returns a list of runtimes that are supported for the requested project.
ListRuntimes(ctx context.Context, in *ListRuntimesRequest, opts ...grpc.CallOption) (*ListRuntimesResponse, error)
}
func NewFunctionServiceClient(cc grpc.ClientConnInterface) FunctionServiceClient
FunctionServiceServer is the server API for FunctionService service.
type FunctionServiceServer interface {
// Returns a function with the given name from the requested project.
GetFunction(context.Context, *GetFunctionRequest) (*Function, error)
// Returns a list of functions that belong to the requested project.
ListFunctions(context.Context, *ListFunctionsRequest) (*ListFunctionsResponse, 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)
// 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.
// * 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`
//
// 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
// 30 minutes of 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)
// Returns a list of runtimes that are supported for the requested project.
ListRuntimes(context.Context, *ListRuntimesRequest) (*ListRuntimesResponse, error)
}
Describes the current state of the function.
type Function_State int32
const (
// Not specified. Invalid state.
Function_STATE_UNSPECIFIED Function_State = 0
// Function has been successfully deployed and is serving.
Function_ACTIVE Function_State = 1
// Function deployment failed and the function is not serving.
Function_FAILED Function_State = 2
// Function is being created or updated.
Function_DEPLOYING Function_State = 3
// Function is being deleted.
Function_DELETING Function_State = 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.
Function_UNKNOWN Function_State = 5
)
func (Function_State) Descriptor() protoreflect.EnumDescriptor
func (x Function_State) Enum() *Function_State
func (Function_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Function_State.Descriptor instead.
func (x Function_State) Number() protoreflect.EnumNumber
func (x Function_State) String() string
func (Function_State) Type() protoreflect.EnumType
Request of `GenerateDownloadUrl` method.
type GenerateDownloadUrlRequest struct {
// Required. 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"`
// contains filtered or unexported fields
}
func (*GenerateDownloadUrlRequest) Descriptor() ([]byte, []int)
Deprecated: Use GenerateDownloadUrlRequest.ProtoReflect.Descriptor instead.
func (x *GenerateDownloadUrlRequest) GetName() string
func (*GenerateDownloadUrlRequest) ProtoMessage()
func (x *GenerateDownloadUrlRequest) ProtoReflect() protoreflect.Message
func (x *GenerateDownloadUrlRequest) Reset()
func (x *GenerateDownloadUrlRequest) String() string
Response of `GenerateDownloadUrl` method.
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
}
func (*GenerateDownloadUrlResponse) Descriptor() ([]byte, []int)
Deprecated: Use GenerateDownloadUrlResponse.ProtoReflect.Descriptor instead.
func (x *GenerateDownloadUrlResponse) GetDownloadUrl() string
func (*GenerateDownloadUrlResponse) ProtoMessage()
func (x *GenerateDownloadUrlResponse) ProtoReflect() protoreflect.Message
func (x *GenerateDownloadUrlResponse) Reset()
func (x *GenerateDownloadUrlResponse) String() string
Request of `GenerateSourceUploadUrl` method.
type GenerateUploadUrlRequest struct {
// Required. 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
}
func (*GenerateUploadUrlRequest) Descriptor() ([]byte, []int)
Deprecated: Use GenerateUploadUrlRequest.ProtoReflect.Descriptor instead.
func (x *GenerateUploadUrlRequest) GetParent() string
func (*GenerateUploadUrlRequest) ProtoMessage()
func (x *GenerateUploadUrlRequest) ProtoReflect() protoreflect.Message
func (x *GenerateUploadUrlRequest) Reset()
func (x *GenerateUploadUrlRequest) String() string
Response of `GenerateSourceUploadUrl` method.
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"`
// The location of the source code in the upload bucket.
//
// Once the archive is uploaded using the `upload_url` use this field to
// set the `function.build_config.source.storage_source`
// during CreateFunction and UpdateFunction.
//
// Generation defaults to 0, as Cloud Storage provides a new generation only
// upon uploading a new object or version of an object.
StorageSource *StorageSource `protobuf:"bytes,2,opt,name=storage_source,json=storageSource,proto3" json:"storage_source,omitempty"`
// contains filtered or unexported fields
}
func (*GenerateUploadUrlResponse) Descriptor() ([]byte, []int)
Deprecated: Use GenerateUploadUrlResponse.ProtoReflect.Descriptor instead.
func (x *GenerateUploadUrlResponse) GetStorageSource() *StorageSource
func (x *GenerateUploadUrlResponse) GetUploadUrl() string
func (*GenerateUploadUrlResponse) ProtoMessage()
func (x *GenerateUploadUrlResponse) ProtoReflect() protoreflect.Message
func (x *GenerateUploadUrlResponse) Reset()
func (x *GenerateUploadUrlResponse) String() string
Request for the `GetFunction` method.
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
}
func (*GetFunctionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetFunctionRequest.ProtoReflect.Descriptor instead.
func (x *GetFunctionRequest) GetName() string
func (*GetFunctionRequest) ProtoMessage()
func (x *GetFunctionRequest) ProtoReflect() protoreflect.Message
func (x *GetFunctionRequest) Reset()
func (x *GetFunctionRequest) String() string
Request for the `ListFunctions` method.
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.
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"`
// The filter for Functions that match the filter expression,
// following the syntax outlined in https://google.aip.dev/160.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// The sorting order of the resources returned. Value should be a comma
// separated list of fields. The default sorting oder is ascending.
// See https://google.aip.dev/132#ordering.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
func (*ListFunctionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFunctionsRequest.ProtoReflect.Descriptor instead.
func (x *ListFunctionsRequest) GetFilter() string
func (x *ListFunctionsRequest) GetOrderBy() string
func (x *ListFunctionsRequest) GetPageSize() int32
func (x *ListFunctionsRequest) GetPageToken() string
func (x *ListFunctionsRequest) GetParent() string
func (*ListFunctionsRequest) ProtoMessage()
func (x *ListFunctionsRequest) ProtoReflect() protoreflect.Message
func (x *ListFunctionsRequest) Reset()
func (x *ListFunctionsRequest) String() string
Response for the `ListFunctions` method.
type ListFunctionsResponse struct {
// The functions that match the request.
Functions []*Function `protobuf:"bytes,1,rep,name=functions,proto3" json:"functions,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
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
}
func (*ListFunctionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListFunctionsResponse.ProtoReflect.Descriptor instead.
func (x *ListFunctionsResponse) GetFunctions() []*Function
func (x *ListFunctionsResponse) GetNextPageToken() string
func (x *ListFunctionsResponse) GetUnreachable() []string
func (*ListFunctionsResponse) ProtoMessage()
func (x *ListFunctionsResponse) ProtoReflect() protoreflect.Message
func (x *ListFunctionsResponse) Reset()
func (x *ListFunctionsResponse) String() string
Request for the `ListRuntimes` method.
type ListRuntimesRequest struct {
// Required. The project and location from which the runtimes should be listed,
// specified in the format `projects/*/locations/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The filter for Runtimes that match the filter expression,
// following the syntax outlined in https://google.aip.dev/160.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListRuntimesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimesRequest.ProtoReflect.Descriptor instead.
func (x *ListRuntimesRequest) GetFilter() string
func (x *ListRuntimesRequest) GetParent() string
func (*ListRuntimesRequest) ProtoMessage()
func (x *ListRuntimesRequest) ProtoReflect() protoreflect.Message
func (x *ListRuntimesRequest) Reset()
func (x *ListRuntimesRequest) String() string
Response for the `ListRuntimes` method.
type ListRuntimesResponse struct {
// The runtimes that match the request.
Runtimes []*ListRuntimesResponse_Runtime `protobuf:"bytes,1,rep,name=runtimes,proto3" json:"runtimes,omitempty"`
// contains filtered or unexported fields
}
func (*ListRuntimesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimesResponse.ProtoReflect.Descriptor instead.
func (x *ListRuntimesResponse) GetRuntimes() []*ListRuntimesResponse_Runtime
func (*ListRuntimesResponse) ProtoMessage()
func (x *ListRuntimesResponse) ProtoReflect() protoreflect.Message
func (x *ListRuntimesResponse) Reset()
func (x *ListRuntimesResponse) String() string
Describes a runtime and any special information (e.g., deprecation status) related to it.
type ListRuntimesResponse_Runtime struct {
// The name of the runtime, e.g., 'go113', 'nodejs12', etc.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The user facing name, eg 'Go 1.13', 'Node.js 12', etc.
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The stage of life this runtime is in, e.g., BETA, GA, etc.
Stage ListRuntimesResponse_RuntimeStage `protobuf:"varint,2,opt,name=stage,proto3,enum=google.cloud.functions.v2alpha.ListRuntimesResponse_RuntimeStage" json:"stage,omitempty"`
// Warning messages, e.g., a deprecation warning.
Warnings []string `protobuf:"bytes,3,rep,name=warnings,proto3" json:"warnings,omitempty"`
// The environment for the runtime.
Environment Environment `protobuf:"varint,4,opt,name=environment,proto3,enum=google.cloud.functions.v2alpha.Environment" json:"environment,omitempty"`
// contains filtered or unexported fields
}
func (*ListRuntimesResponse_Runtime) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimesResponse_Runtime.ProtoReflect.Descriptor instead.
func (x *ListRuntimesResponse_Runtime) GetDisplayName() string
func (x *ListRuntimesResponse_Runtime) GetEnvironment() Environment
func (x *ListRuntimesResponse_Runtime) GetName() string
func (x *ListRuntimesResponse_Runtime) GetStage() ListRuntimesResponse_RuntimeStage
func (x *ListRuntimesResponse_Runtime) GetWarnings() []string
func (*ListRuntimesResponse_Runtime) ProtoMessage()
func (x *ListRuntimesResponse_Runtime) ProtoReflect() protoreflect.Message
func (x *ListRuntimesResponse_Runtime) Reset()
func (x *ListRuntimesResponse_Runtime) String() string
The various stages that a runtime can be in.
type ListRuntimesResponse_RuntimeStage int32
const (
// Not specified.
ListRuntimesResponse_RUNTIME_STAGE_UNSPECIFIED ListRuntimesResponse_RuntimeStage = 0
// The runtime is in development.
ListRuntimesResponse_DEVELOPMENT ListRuntimesResponse_RuntimeStage = 1
// The runtime is in the Alpha stage.
ListRuntimesResponse_ALPHA ListRuntimesResponse_RuntimeStage = 2
// The runtime is in the Beta stage.
ListRuntimesResponse_BETA ListRuntimesResponse_RuntimeStage = 3
// The runtime is generally available.
ListRuntimesResponse_GA ListRuntimesResponse_RuntimeStage = 4
// The runtime is deprecated.
ListRuntimesResponse_DEPRECATED ListRuntimesResponse_RuntimeStage = 5
// The runtime is no longer supported.
ListRuntimesResponse_DECOMMISSIONED ListRuntimesResponse_RuntimeStage = 6
)
func (ListRuntimesResponse_RuntimeStage) Descriptor() protoreflect.EnumDescriptor
func (x ListRuntimesResponse_RuntimeStage) Enum() *ListRuntimesResponse_RuntimeStage
func (ListRuntimesResponse_RuntimeStage) EnumDescriptor() ([]byte, []int)
Deprecated: Use ListRuntimesResponse_RuntimeStage.Descriptor instead.
func (x ListRuntimesResponse_RuntimeStage) Number() protoreflect.EnumNumber
func (x ListRuntimesResponse_RuntimeStage) String() string
func (ListRuntimesResponse_RuntimeStage) Type() protoreflect.EnumType
Represents the metadata of the long-running operation.
type OperationMetadata struct {
// The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Server-defined resource path for the target of the operation.
Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Name of the verb executed by the operation.
Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Human-readable status of the operation, if any.
StatusDetail string `protobuf:"bytes,5,opt,name=status_detail,json=statusDetail,proto3" json:"status_detail,omitempty"`
// Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
// have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`.
CancelRequested bool `protobuf:"varint,6,opt,name=cancel_requested,json=cancelRequested,proto3" json:"cancel_requested,omitempty"`
// API version used to start the operation.
ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// The original request that started the operation.
RequestResource *anypb.Any `protobuf:"bytes,8,opt,name=request_resource,json=requestResource,proto3" json:"request_resource,omitempty"`
// Mechanism for reporting in-progress stages
Stages []*Stage `protobuf:"bytes,9,rep,name=stages,proto3" json:"stages,omitempty"`
// contains filtered or unexported fields
}
func (*OperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (x *OperationMetadata) GetApiVersion() string
func (x *OperationMetadata) GetCancelRequested() bool
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp
func (x *OperationMetadata) GetRequestResource() *anypb.Any
func (x *OperationMetadata) GetStages() []*Stage
func (x *OperationMetadata) GetStatusDetail() string
func (x *OperationMetadata) GetTarget() string
func (x *OperationMetadata) GetVerb() string
func (*OperationMetadata) ProtoMessage()
func (x *OperationMetadata) ProtoReflect() protoreflect.Message
func (x *OperationMetadata) Reset()
func (x *OperationMetadata) String() string
Location of the source in a Google Cloud Source Repository.
type RepoSource struct {
// A revision within the Cloud Source Repository must be specified in
// one of these ways.
//
// Types that are assignable to Revision:
// *RepoSource_BranchName
// *RepoSource_TagName
// *RepoSource_CommitSha
Revision isRepoSource_Revision `protobuf_oneof:"revision"`
// ID of the project that owns the Cloud Source Repository. If omitted, the
// project ID requesting the build is assumed.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Name of the Cloud Source Repository.
RepoName string `protobuf:"bytes,2,opt,name=repo_name,json=repoName,proto3" json:"repo_name,omitempty"`
// Directory, relative to the source root, in which to run the build.
//
// This must be a relative path. If a step's `dir` is specified and is an
// absolute path, this value is ignored for that step's execution.
// eg. helloworld (no leading slash allowed)
Dir string `protobuf:"bytes,6,opt,name=dir,proto3" json:"dir,omitempty"`
// Only trigger a build if the revision regex does NOT match the revision
// regex.
InvertRegex bool `protobuf:"varint,7,opt,name=invert_regex,json=invertRegex,proto3" json:"invert_regex,omitempty"`
// contains filtered or unexported fields
}
func (*RepoSource) Descriptor() ([]byte, []int)
Deprecated: Use RepoSource.ProtoReflect.Descriptor instead.
func (x *RepoSource) GetBranchName() string
func (x *RepoSource) GetCommitSha() string
func (x *RepoSource) GetDir() string
func (x *RepoSource) GetInvertRegex() bool
func (x *RepoSource) GetProjectId() string
func (x *RepoSource) GetRepoName() string
func (m *RepoSource) GetRevision() isRepoSource_Revision
func (x *RepoSource) GetTagName() string
func (*RepoSource) ProtoMessage()
func (x *RepoSource) ProtoReflect() protoreflect.Message
func (x *RepoSource) Reset()
func (x *RepoSource) String() string
type RepoSource_BranchName struct {
// Regex matching branches to build.
//
// The syntax of the regular expressions accepted is the syntax accepted by
// RE2 and described at https://github.com/google/re2/wiki/Syntax
BranchName string `protobuf:"bytes,3,opt,name=branch_name,json=branchName,proto3,oneof"`
}
type RepoSource_CommitSha struct {
// Explicit commit SHA to build.
CommitSha string `protobuf:"bytes,5,opt,name=commit_sha,json=commitSha,proto3,oneof"`
}
type RepoSource_TagName struct {
// Regex matching tags to build.
//
// The syntax of the regular expressions accepted is the syntax accepted by
// RE2 and described at https://github.com/google/re2/wiki/Syntax
TagName string `protobuf:"bytes,4,opt,name=tag_name,json=tagName,proto3,oneof"`
}
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.
type SecretEnvVar struct {
// Name of the environment variable.
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// Project identifier (preferably project number but can also be the
// project ID) of the project that contains the secret. If not set, it is
// assumed that the secret is in the same project as 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 instances
// start.
Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
// contains filtered or unexported fields
}
func (*SecretEnvVar) Descriptor() ([]byte, []int)
Deprecated: Use SecretEnvVar.ProtoReflect.Descriptor instead.
func (x *SecretEnvVar) GetKey() string
func (x *SecretEnvVar) GetProjectId() string
func (x *SecretEnvVar) GetSecret() string
func (x *SecretEnvVar) GetVersion() string
func (*SecretEnvVar) ProtoMessage()
func (x *SecretEnvVar) ProtoReflect() protoreflect.Message
func (x *SecretEnvVar) Reset()
func (x *SecretEnvVar) String() string
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.
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 path: /etc/secrets
MountPath string `protobuf:"bytes,1,opt,name=mount_path,json=mountPath,proto3" json:"mount_path,omitempty"`
// Project identifier (preferably project number but can also be the project
// ID) of the project that contains the secret. If not set, it is
// assumed that the secret is in the same project as 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
}
func (*SecretVolume) Descriptor() ([]byte, []int)
Deprecated: Use SecretVolume.ProtoReflect.Descriptor instead.
func (x *SecretVolume) GetMountPath() string
func (x *SecretVolume) GetProjectId() string
func (x *SecretVolume) GetSecret() string
func (x *SecretVolume) GetVersions() []*SecretVolume_SecretVersion
func (*SecretVolume) ProtoMessage()
func (x *SecretVolume) ProtoReflect() protoreflect.Message
func (x *SecretVolume) Reset()
func (x *SecretVolume) String() string
Configuration for a single version.
type SecretVolume_SecretVersion struct {
// Version of the secret (version number or the string 'latest'). It is
// preferable 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
}
func (*SecretVolume_SecretVersion) Descriptor() ([]byte, []int)
Deprecated: Use SecretVolume_SecretVersion.ProtoReflect.Descriptor instead.
func (x *SecretVolume_SecretVersion) GetPath() string
func (x *SecretVolume_SecretVersion) GetVersion() string
func (*SecretVolume_SecretVersion) ProtoMessage()
func (x *SecretVolume_SecretVersion) ProtoReflect() protoreflect.Message
func (x *SecretVolume_SecretVersion) Reset()
func (x *SecretVolume_SecretVersion) String() string
Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
type ServiceConfig struct {
// Output only. Name of the service associated with a Function.
// The format of this field is
// `projects/{project}/locations/{region}/services/{service}`
Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,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.
TimeoutSeconds int32 `protobuf:"varint,2,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"`
// The amount of memory available for a function.
// Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is
// supplied the value is interpreted as bytes.
// See
// https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
// a full description.
AvailableMemory string `protobuf:"bytes,13,opt,name=available_memory,json=availableMemory,proto3" json:"available_memory,omitempty"`
// Environment variables that shall be available during function execution.
EnvironmentVariables map[string]string `protobuf:"bytes,4,rep,name=environment_variables,json=environmentVariables,proto3" json:"environment_variables,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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.
MaxInstanceCount int32 `protobuf:"varint,5,opt,name=max_instance_count,json=maxInstanceCount,proto3" json:"max_instance_count,omitempty"`
// The limit on the minimum number of function instances that may coexist at a
// given time.
//
// Function instances are kept in idle state for a short period after they
// finished executing the request to reduce cold start time for subsequent
// requests. Setting a minimum instance count will ensure that the given
// number of instances are kept running in idle state always. This can help
// with cold start times when jump in incoming request count occurs after the
// idle instance would have been stopped in the default case.
MinInstanceCount int32 `protobuf:"varint,12,opt,name=min_instance_count,json=minInstanceCount,proto3" json:"min_instance_count,omitempty"`
// The Serverless VPC Access connector that this cloud function can connect
// to. The format of this field is `projects/*/locations/*/connectors/*`.
VpcConnector string `protobuf:"bytes,6,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 ServiceConfig_VpcConnectorEgressSettings `protobuf:"varint,7,opt,name=vpc_connector_egress_settings,json=vpcConnectorEgressSettings,proto3,enum=google.cloud.functions.v2alpha.ServiceConfig_VpcConnectorEgressSettings" json:"vpc_connector_egress_settings,omitempty"`
// The ingress settings for the function, controlling what traffic can reach
// it.
IngressSettings ServiceConfig_IngressSettings `protobuf:"varint,8,opt,name=ingress_settings,json=ingressSettings,proto3,enum=google.cloud.functions.v2alpha.ServiceConfig_IngressSettings" json:"ingress_settings,omitempty"`
// Output only. URI of the Service deployed.
Uri string `protobuf:"bytes,9,opt,name=uri,proto3" json:"uri,omitempty"`
// The email of the service's service account. If empty, defaults to
// `{project_number}-compute@developer.gserviceaccount.com`.
ServiceAccountEmail string `protobuf:"bytes,10,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// Whether 100% of traffic is routed to the latest revision.
// On CreateFunction and UpdateFunction, when set to true, the revision being
// deployed will serve 100% of traffic, ignoring any traffic split settings,
// if any. On GetFunction, true will be returned if the latest revision is
// serving 100% of traffic.
AllTrafficOnLatestRevision bool `protobuf:"varint,16,opt,name=all_traffic_on_latest_revision,json=allTrafficOnLatestRevision,proto3" json:"all_traffic_on_latest_revision,omitempty"`
// Secret environment variables configuration.
SecretEnvironmentVariables []*SecretEnvVar `protobuf:"bytes,17,rep,name=secret_environment_variables,json=secretEnvironmentVariables,proto3" json:"secret_environment_variables,omitempty"`
// Secret volumes configuration.
SecretVolumes []*SecretVolume `protobuf:"bytes,19,rep,name=secret_volumes,json=secretVolumes,proto3" json:"secret_volumes,omitempty"`
// Output only. The name of service revision.
Revision string `protobuf:"bytes,18,opt,name=revision,proto3" json:"revision,omitempty"`
// contains filtered or unexported fields
}
func (*ServiceConfig) Descriptor() ([]byte, []int)
Deprecated: Use ServiceConfig.ProtoReflect.Descriptor instead.
func (x *ServiceConfig) GetAllTrafficOnLatestRevision() bool
func (x *ServiceConfig) GetAvailableMemory() string
func (x *ServiceConfig) GetEnvironmentVariables() map[string]string
func (x *ServiceConfig) GetIngressSettings() ServiceConfig_IngressSettings
func (x *ServiceConfig) GetMaxInstanceCount() int32
func (x *ServiceConfig) GetMinInstanceCount() int32
func (x *ServiceConfig) GetRevision() string
func (x *ServiceConfig) GetSecretEnvironmentVariables() []*SecretEnvVar
func (x *ServiceConfig) GetSecretVolumes() []*SecretVolume
func (x *ServiceConfig) GetService() string
func (x *ServiceConfig) GetServiceAccountEmail() string
func (x *ServiceConfig) GetTimeoutSeconds() int32
func (x *ServiceConfig) GetUri() string
func (x *ServiceConfig) GetVpcConnector() string
func (x *ServiceConfig) GetVpcConnectorEgressSettings() ServiceConfig_VpcConnectorEgressSettings
func (*ServiceConfig) ProtoMessage()
func (x *ServiceConfig) ProtoReflect() protoreflect.Message
func (x *ServiceConfig) Reset()
func (x *ServiceConfig) String() string
Available ingress settings.
This controls what traffic can reach the function.
If unspecified, ALLOW_ALL will be used.
type ServiceConfig_IngressSettings int32
const (
// Unspecified.
ServiceConfig_INGRESS_SETTINGS_UNSPECIFIED ServiceConfig_IngressSettings = 0
// Allow HTTP traffic from public and private sources.
ServiceConfig_ALLOW_ALL ServiceConfig_IngressSettings = 1
// Allow HTTP traffic from only private VPC sources.
ServiceConfig_ALLOW_INTERNAL_ONLY ServiceConfig_IngressSettings = 2
// Allow HTTP traffic from private VPC sources and through GCLB.
ServiceConfig_ALLOW_INTERNAL_AND_GCLB ServiceConfig_IngressSettings = 3
)
func (ServiceConfig_IngressSettings) Descriptor() protoreflect.EnumDescriptor
func (x ServiceConfig_IngressSettings) Enum() *ServiceConfig_IngressSettings
func (ServiceConfig_IngressSettings) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceConfig_IngressSettings.Descriptor instead.
func (x ServiceConfig_IngressSettings) Number() protoreflect.EnumNumber
func (x ServiceConfig_IngressSettings) String() string
func (ServiceConfig_IngressSettings) Type() protoreflect.EnumType
Available egress settings.
This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.
type ServiceConfig_VpcConnectorEgressSettings int32
const (
// Unspecified.
ServiceConfig_VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED ServiceConfig_VpcConnectorEgressSettings = 0
// Use the VPC Access Connector only for private IP space from RFC1918.
ServiceConfig_PRIVATE_RANGES_ONLY ServiceConfig_VpcConnectorEgressSettings = 1
// Force the use of VPC Access Connector for all egress traffic from the
// function.
ServiceConfig_ALL_TRAFFIC ServiceConfig_VpcConnectorEgressSettings = 2
)
func (ServiceConfig_VpcConnectorEgressSettings) Descriptor() protoreflect.EnumDescriptor
func (x ServiceConfig_VpcConnectorEgressSettings) Enum() *ServiceConfig_VpcConnectorEgressSettings
func (ServiceConfig_VpcConnectorEgressSettings) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceConfig_VpcConnectorEgressSettings.Descriptor instead.
func (x ServiceConfig_VpcConnectorEgressSettings) Number() protoreflect.EnumNumber
func (x ServiceConfig_VpcConnectorEgressSettings) String() string
func (ServiceConfig_VpcConnectorEgressSettings) Type() protoreflect.EnumType
The location of the function source code.
type Source struct {
// Location of the source.
// At least one source needs to be provided for the deployment to succeed.
//
// Types that are assignable to Source:
// *Source_StorageSource
// *Source_RepoSource
Source isSource_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}
func (*Source) Descriptor() ([]byte, []int)
Deprecated: Use Source.ProtoReflect.Descriptor instead.
func (x *Source) GetRepoSource() *RepoSource
func (m *Source) GetSource() isSource_Source
func (x *Source) GetStorageSource() *StorageSource
func (*Source) ProtoMessage()
func (x *Source) ProtoReflect() protoreflect.Message
func (x *Source) Reset()
func (x *Source) String() string
Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
type SourceProvenance struct {
// A copy of the build's `source.storage_source`, if exists, with any
// generations resolved.
ResolvedStorageSource *StorageSource `protobuf:"bytes,1,opt,name=resolved_storage_source,json=resolvedStorageSource,proto3" json:"resolved_storage_source,omitempty"`
// A copy of the build's `source.repo_source`, if exists, with any
// revisions resolved.
ResolvedRepoSource *RepoSource `protobuf:"bytes,2,opt,name=resolved_repo_source,json=resolvedRepoSource,proto3" json:"resolved_repo_source,omitempty"`
// contains filtered or unexported fields
}
func (*SourceProvenance) Descriptor() ([]byte, []int)
Deprecated: Use SourceProvenance.ProtoReflect.Descriptor instead.
func (x *SourceProvenance) GetResolvedRepoSource() *RepoSource
func (x *SourceProvenance) GetResolvedStorageSource() *StorageSource
func (*SourceProvenance) ProtoMessage()
func (x *SourceProvenance) ProtoReflect() protoreflect.Message
func (x *SourceProvenance) Reset()
func (x *SourceProvenance) String() string
type Source_RepoSource struct {
// If provided, get the source from this location in a Cloud Source
// Repository.
RepoSource *RepoSource `protobuf:"bytes,2,opt,name=repo_source,json=repoSource,proto3,oneof"`
}
type Source_StorageSource struct {
// If provided, get the source from this location in Google Cloud Storage.
StorageSource *StorageSource `protobuf:"bytes,1,opt,name=storage_source,json=storageSource,proto3,oneof"`
}
Each Stage of the deployment process
type Stage struct {
// Name of the Stage. This will be unique for each Stage.
Name Stage_Name `protobuf:"varint,1,opt,name=name,proto3,enum=google.cloud.functions.v2alpha.Stage_Name" json:"name,omitempty"`
// Message describing the Stage
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// Current state of the Stage
State Stage_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.functions.v2alpha.Stage_State" json:"state,omitempty"`
// Resource of the Stage
Resource string `protobuf:"bytes,4,opt,name=resource,proto3" json:"resource,omitempty"`
// Link to the current Stage resource
ResourceUri string `protobuf:"bytes,5,opt,name=resource_uri,json=resourceUri,proto3" json:"resource_uri,omitempty"`
// State messages from the current Stage.
StateMessages []*StateMessage `protobuf:"bytes,6,rep,name=state_messages,json=stateMessages,proto3" json:"state_messages,omitempty"`
// contains filtered or unexported fields
}
func (*Stage) Descriptor() ([]byte, []int)
Deprecated: Use Stage.ProtoReflect.Descriptor instead.
func (x *Stage) GetMessage() string
func (x *Stage) GetName() Stage_Name
func (x *Stage) GetResource() string
func (x *Stage) GetResourceUri() string
func (x *Stage) GetState() Stage_State
func (x *Stage) GetStateMessages() []*StateMessage
func (*Stage) ProtoMessage()
func (x *Stage) ProtoReflect() protoreflect.Message
func (x *Stage) Reset()
func (x *Stage) String() string
Possible names for a Stage
type Stage_Name int32
const (
// Not specified. Invalid name.
Stage_NAME_UNSPECIFIED Stage_Name = 0
// Artifact Regsitry Stage
Stage_ARTIFACT_REGISTRY Stage_Name = 1
// Build Stage
Stage_BUILD Stage_Name = 2
// Service Stage
Stage_SERVICE Stage_Name = 3
// Trigger Stage
Stage_TRIGGER Stage_Name = 4
// Service Rollback Stage
Stage_SERVICE_ROLLBACK Stage_Name = 5
// Trigger Rollback Stage
Stage_TRIGGER_ROLLBACK Stage_Name = 6
)
func (Stage_Name) Descriptor() protoreflect.EnumDescriptor
func (x Stage_Name) Enum() *Stage_Name
func (Stage_Name) EnumDescriptor() ([]byte, []int)
Deprecated: Use Stage_Name.Descriptor instead.
func (x Stage_Name) Number() protoreflect.EnumNumber
func (x Stage_Name) String() string
func (Stage_Name) Type() protoreflect.EnumType
Possible states for a Stage
type Stage_State int32
const (
// Not specified. Invalid state.
Stage_STATE_UNSPECIFIED Stage_State = 0
// Stage has not started.
Stage_NOT_STARTED Stage_State = 1
// Stage is in progress.
Stage_IN_PROGRESS Stage_State = 2
// Stage has completed.
Stage_COMPLETE Stage_State = 3
)
func (Stage_State) Descriptor() protoreflect.EnumDescriptor
func (x Stage_State) Enum() *Stage_State
func (Stage_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Stage_State.Descriptor instead.
func (x Stage_State) Number() protoreflect.EnumNumber
func (x Stage_State) String() string
func (Stage_State) Type() protoreflect.EnumType
Informational messages about the state of the Cloud Function or Operation.
type StateMessage struct {
// Severity of the state message.
Severity StateMessage_Severity `protobuf:"varint,1,opt,name=severity,proto3,enum=google.cloud.functions.v2alpha.StateMessage_Severity" json:"severity,omitempty"`
// One-word CamelCase type of the state message.
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
// The message.
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*StateMessage) Descriptor() ([]byte, []int)
Deprecated: Use StateMessage.ProtoReflect.Descriptor instead.
func (x *StateMessage) GetMessage() string
func (x *StateMessage) GetSeverity() StateMessage_Severity
func (x *StateMessage) GetType() string
func (*StateMessage) ProtoMessage()
func (x *StateMessage) ProtoReflect() protoreflect.Message
func (x *StateMessage) Reset()
func (x *StateMessage) String() string
Severity of the state message.
type StateMessage_Severity int32
const (
// Not specified. Invalid severity.
StateMessage_SEVERITY_UNSPECIFIED StateMessage_Severity = 0
// ERROR-level severity.
StateMessage_ERROR StateMessage_Severity = 1
// WARNING-level severity.
StateMessage_WARNING StateMessage_Severity = 2
// INFO-level severity.
StateMessage_INFO StateMessage_Severity = 3
)
func (StateMessage_Severity) Descriptor() protoreflect.EnumDescriptor
func (x StateMessage_Severity) Enum() *StateMessage_Severity
func (StateMessage_Severity) EnumDescriptor() ([]byte, []int)
Deprecated: Use StateMessage_Severity.Descriptor instead.
func (x StateMessage_Severity) Number() protoreflect.EnumNumber
func (x StateMessage_Severity) String() string
func (StateMessage_Severity) Type() protoreflect.EnumType
Location of the source in an archive file in Google Cloud Storage.
type StorageSource struct {
// Google Cloud Storage bucket containing the source (see
// [Bucket Name
// Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Google Cloud Storage object containing the source.
//
// This object must be a gzipped archive file (`.tar.gz`) containing source to
// build.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Google Cloud Storage generation for the object. If the generation is
// omitted, the latest generation will be used.
Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// contains filtered or unexported fields
}
func (*StorageSource) Descriptor() ([]byte, []int)
Deprecated: Use StorageSource.ProtoReflect.Descriptor instead.
func (x *StorageSource) GetBucket() string
func (x *StorageSource) GetGeneration() int64
func (x *StorageSource) GetObject() string
func (*StorageSource) ProtoMessage()
func (x *StorageSource) ProtoReflect() protoreflect.Message
func (x *StorageSource) Reset()
func (x *StorageSource) String() string
UnimplementedFunctionServiceServer can be embedded to have forward compatible implementations.
type UnimplementedFunctionServiceServer struct {
}
func (*UnimplementedFunctionServiceServer) CreateFunction(context.Context, *CreateFunctionRequest) (*longrunning.Operation, error)
func (*UnimplementedFunctionServiceServer) DeleteFunction(context.Context, *DeleteFunctionRequest) (*longrunning.Operation, error)
func (*UnimplementedFunctionServiceServer) GenerateDownloadUrl(context.Context, *GenerateDownloadUrlRequest) (*GenerateDownloadUrlResponse, error)
func (*UnimplementedFunctionServiceServer) GenerateUploadUrl(context.Context, *GenerateUploadUrlRequest) (*GenerateUploadUrlResponse, error)
func (*UnimplementedFunctionServiceServer) GetFunction(context.Context, *GetFunctionRequest) (*Function, error)
func (*UnimplementedFunctionServiceServer) ListFunctions(context.Context, *ListFunctionsRequest) (*ListFunctionsResponse, error)
func (*UnimplementedFunctionServiceServer) ListRuntimes(context.Context, *ListRuntimesRequest) (*ListRuntimesResponse, error)
func (*UnimplementedFunctionServiceServer) UpdateFunction(context.Context, *UpdateFunctionRequest) (*longrunning.Operation, error)
Request for the `UpdateFunction` method.
type UpdateFunctionRequest struct {
// Required. New version of the function.
Function *Function `protobuf:"bytes,1,opt,name=function,proto3" json:"function,omitempty"`
// The list of fields to be updated.
// If no field mask is provided, all provided fields in the request will be
// updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateFunctionRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateFunctionRequest.ProtoReflect.Descriptor instead.
func (x *UpdateFunctionRequest) GetFunction() *Function
func (x *UpdateFunctionRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateFunctionRequest) ProtoMessage()
func (x *UpdateFunctionRequest) ProtoReflect() protoreflect.Message
func (x *UpdateFunctionRequest) Reset()
func (x *UpdateFunctionRequest) String() string