Workflows API v1 - Package cloud.google.com/go/workflows/apiv1/workflowspb (v1.19.0)

Constants

Workflows_ListWorkflows_FullMethodName, Workflows_GetWorkflow_FullMethodName, Workflows_CreateWorkflow_FullMethodName, Workflows_DeleteWorkflow_FullMethodName, Workflows_UpdateWorkflow_FullMethodName, Workflows_ListWorkflowRevisions_FullMethodName

const (
	Workflows_ListWorkflows_FullMethodName         = "/google.cloud.workflows.v1.Workflows/ListWorkflows"
	Workflows_GetWorkflow_FullMethodName           = "/google.cloud.workflows.v1.Workflows/GetWorkflow"
	Workflows_CreateWorkflow_FullMethodName        = "/google.cloud.workflows.v1.Workflows/CreateWorkflow"
	Workflows_DeleteWorkflow_FullMethodName        = "/google.cloud.workflows.v1.Workflows/DeleteWorkflow"
	Workflows_UpdateWorkflow_FullMethodName        = "/google.cloud.workflows.v1.Workflows/UpdateWorkflow"
	Workflows_ListWorkflowRevisions_FullMethodName = "/google.cloud.workflows.v1.Workflows/ListWorkflowRevisions"
)

Variables

ExecutionHistoryLevel_name, ExecutionHistoryLevel_value

var (
	ExecutionHistoryLevel_name = map[int32]string{
		0: "EXECUTION_HISTORY_LEVEL_UNSPECIFIED",
		1: "EXECUTION_HISTORY_BASIC",
		2: "EXECUTION_HISTORY_DETAILED",
	}
	ExecutionHistoryLevel_value = map[string]int32{
		"EXECUTION_HISTORY_LEVEL_UNSPECIFIED": 0,
		"EXECUTION_HISTORY_BASIC":             1,
		"EXECUTION_HISTORY_DETAILED":          2,
	}
)

Enum value maps for ExecutionHistoryLevel.

Workflow_State_name, Workflow_State_value

var (
	Workflow_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACTIVE",
		2: "UNAVAILABLE",
	}
	Workflow_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACTIVE":            1,
		"UNAVAILABLE":       2,
	}
)

Enum value maps for Workflow_State.

Workflow_CallLogLevel_name, Workflow_CallLogLevel_value

var (
	Workflow_CallLogLevel_name = map[int32]string{
		0: "CALL_LOG_LEVEL_UNSPECIFIED",
		1: "LOG_ALL_CALLS",
		2: "LOG_ERRORS_ONLY",
		3: "LOG_NONE",
	}
	Workflow_CallLogLevel_value = map[string]int32{
		"CALL_LOG_LEVEL_UNSPECIFIED": 0,
		"LOG_ALL_CALLS":              1,
		"LOG_ERRORS_ONLY":            2,
		"LOG_NONE":                   3,
	}
)

Enum value maps for Workflow_CallLogLevel.

Workflow_StateError_Type_name, Workflow_StateError_Type_value

var (
	Workflow_StateError_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "KMS_ERROR",
	}
	Workflow_StateError_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"KMS_ERROR":        1,
	}
)

Enum value maps for Workflow_StateError_Type.

File_google_cloud_workflows_v1_workflows_proto

var File_google_cloud_workflows_v1_workflows_proto protoreflect.FileDescriptor

Workflows_ServiceDesc

var Workflows_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.workflows.v1.Workflows",
	HandlerType: (*WorkflowsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListWorkflows",
			Handler:    _Workflows_ListWorkflows_Handler,
		},
		{
			MethodName: "GetWorkflow",
			Handler:    _Workflows_GetWorkflow_Handler,
		},
		{
			MethodName: "CreateWorkflow",
			Handler:    _Workflows_CreateWorkflow_Handler,
		},
		{
			MethodName: "DeleteWorkflow",
			Handler:    _Workflows_DeleteWorkflow_Handler,
		},
		{
			MethodName: "UpdateWorkflow",
			Handler:    _Workflows_UpdateWorkflow_Handler,
		},
		{
			MethodName: "ListWorkflowRevisions",
			Handler:    _Workflows_ListWorkflowRevisions_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/workflows/v1/workflows.proto",
}

Workflows_ServiceDesc is the grpc.ServiceDesc for Workflows service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterWorkflowsServer

func RegisterWorkflowsServer(s grpc.ServiceRegistrar, srv WorkflowsServer)

CreateWorkflowRequest

type CreateWorkflowRequest struct {

	// Required. Project and location in which the workflow should be created.
	// Format:  projects/{project}/locations/{location}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Workflow to be created.
	Workflow *Workflow `protobuf:"bytes,2,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// Required. The ID of the workflow to be created. It has to fulfill the
	// following requirements:
	//
	// * Must contain only letters, numbers, underscores and hyphens.
	// * Must start with a letter.
	// * Must be between 1-64 characters.
	// * Must end with a number or a letter.
	// * Must be unique within the customer project and location.
	WorkflowId string `protobuf:"bytes,3,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	// contains filtered or unexported fields
}

Request for the [CreateWorkflow][google.cloud.workflows.v1.Workflows.CreateWorkflow] method.

func (*CreateWorkflowRequest) Descriptor

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

Deprecated: Use CreateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*CreateWorkflowRequest) GetParent

func (x *CreateWorkflowRequest) GetParent() string

func (*CreateWorkflowRequest) GetWorkflow

func (x *CreateWorkflowRequest) GetWorkflow() *Workflow

func (*CreateWorkflowRequest) GetWorkflowId

func (x *CreateWorkflowRequest) GetWorkflowId() string

func (*CreateWorkflowRequest) ProtoMessage

func (*CreateWorkflowRequest) ProtoMessage()

func (*CreateWorkflowRequest) ProtoReflect

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

func (*CreateWorkflowRequest) Reset

func (x *CreateWorkflowRequest) Reset()

func (*CreateWorkflowRequest) String

func (x *CreateWorkflowRequest) String() string

DeleteWorkflowRequest

type DeleteWorkflowRequest struct {

	// Required. Name of the workflow to be deleted.
	// Format: projects/{project}/locations/{location}/workflows/{workflow}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the [DeleteWorkflow][google.cloud.workflows.v1.Workflows.DeleteWorkflow] method.

func (*DeleteWorkflowRequest) Descriptor

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

Deprecated: Use DeleteWorkflowRequest.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowRequest) GetName

func (x *DeleteWorkflowRequest) GetName() string

func (*DeleteWorkflowRequest) ProtoMessage

func (*DeleteWorkflowRequest) ProtoMessage()

func (*DeleteWorkflowRequest) ProtoReflect

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

func (*DeleteWorkflowRequest) Reset

func (x *DeleteWorkflowRequest) Reset()

func (*DeleteWorkflowRequest) String

func (x *DeleteWorkflowRequest) String() string

ExecutionHistoryLevel

type ExecutionHistoryLevel int32

Define possible options for enabling the execution history level.

ExecutionHistoryLevel_EXECUTION_HISTORY_LEVEL_UNSPECIFIED, ExecutionHistoryLevel_EXECUTION_HISTORY_BASIC, ExecutionHistoryLevel_EXECUTION_HISTORY_DETAILED

const (
	// The default/unset value.
	ExecutionHistoryLevel_EXECUTION_HISTORY_LEVEL_UNSPECIFIED ExecutionHistoryLevel = 0
	// Enable execution history basic feature.
	ExecutionHistoryLevel_EXECUTION_HISTORY_BASIC ExecutionHistoryLevel = 1
	// Enable execution history detailed feature.
	ExecutionHistoryLevel_EXECUTION_HISTORY_DETAILED ExecutionHistoryLevel = 2
)

func (ExecutionHistoryLevel) Descriptor

func (ExecutionHistoryLevel) Descriptor() protoreflect.EnumDescriptor

func (ExecutionHistoryLevel) Enum

func (x ExecutionHistoryLevel) Enum() *ExecutionHistoryLevel

func (ExecutionHistoryLevel) EnumDescriptor

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

Deprecated: Use ExecutionHistoryLevel.Descriptor instead.

func (ExecutionHistoryLevel) Number

func (x ExecutionHistoryLevel) Number() protoreflect.EnumNumber

func (ExecutionHistoryLevel) String

func (x ExecutionHistoryLevel) String() string

func (ExecutionHistoryLevel) Type

func (ExecutionHistoryLevel) Type() protoreflect.EnumType

GetWorkflowRequest

type GetWorkflowRequest struct {

	// Required. Name of the workflow for which information should be retrieved.
	// Format: projects/{project}/locations/{location}/workflows/{workflow}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The revision of the workflow to retrieve. If the revision_id is
	// empty, the latest revision is retrieved.
	// The format is "000001-a4d", where the first six characters define
	// the zero-padded decimal revision number. They are followed by a hyphen and
	// three hexadecimal characters.
	RevisionId string `protobuf:"bytes,2,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// contains filtered or unexported fields
}

Request for the [GetWorkflow][google.cloud.workflows.v1.Workflows.GetWorkflow] method.

func (*GetWorkflowRequest) Descriptor

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

Deprecated: Use GetWorkflowRequest.ProtoReflect.Descriptor instead.

func (*GetWorkflowRequest) GetName

func (x *GetWorkflowRequest) GetName() string

func (*GetWorkflowRequest) GetRevisionId

func (x *GetWorkflowRequest) GetRevisionId() string

func (*GetWorkflowRequest) ProtoMessage

func (*GetWorkflowRequest) ProtoMessage()

func (*GetWorkflowRequest) ProtoReflect

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

func (*GetWorkflowRequest) Reset

func (x *GetWorkflowRequest) Reset()

func (*GetWorkflowRequest) String

func (x *GetWorkflowRequest) String() string

ListWorkflowRevisionsRequest

type ListWorkflowRevisionsRequest struct {

	// Required. Workflow for which the revisions should be listed.
	// Format: projects/{project}/locations/{location}/workflows/{workflow}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The maximum number of revisions to return per page. If a value is not
	// specified, a default value of 20 is used. The maximum permitted value is
	// 100. Values greater than 100 are coerced down to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page token, received from a previous ListWorkflowRevisions call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for the [ListWorkflowRevisions][google.cloud.workflows.v1.Workflows.ListWorkflowRevisions] method.

func (*ListWorkflowRevisionsRequest) Descriptor

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

Deprecated: Use ListWorkflowRevisionsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowRevisionsRequest) GetName

func (x *ListWorkflowRevisionsRequest) GetName() string

func (*ListWorkflowRevisionsRequest) GetPageSize

func (x *ListWorkflowRevisionsRequest) GetPageSize() int32

func (*ListWorkflowRevisionsRequest) GetPageToken

func (x *ListWorkflowRevisionsRequest) GetPageToken() string

func (*ListWorkflowRevisionsRequest) ProtoMessage

func (*ListWorkflowRevisionsRequest) ProtoMessage()

func (*ListWorkflowRevisionsRequest) ProtoReflect

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

func (*ListWorkflowRevisionsRequest) Reset

func (x *ListWorkflowRevisionsRequest) Reset()

func (*ListWorkflowRevisionsRequest) String

func (x *ListWorkflowRevisionsRequest) String() string

ListWorkflowRevisionsResponse

type ListWorkflowRevisionsResponse struct {

	// The revisions of the workflow, ordered in reverse chronological order.
	Workflows []*Workflow `protobuf:"bytes,1,rep,name=workflows,proto3" json:"workflows,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"`
	// contains filtered or unexported fields
}

Response for the [ListWorkflowRevisions][google.cloud.workflows.v1.Workflows.ListWorkflowRevisions] method.

func (*ListWorkflowRevisionsResponse) Descriptor

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

Deprecated: Use ListWorkflowRevisionsResponse.ProtoReflect.Descriptor instead.

func (*ListWorkflowRevisionsResponse) GetNextPageToken

func (x *ListWorkflowRevisionsResponse) GetNextPageToken() string

func (*ListWorkflowRevisionsResponse) GetWorkflows

func (x *ListWorkflowRevisionsResponse) GetWorkflows() []*Workflow

func (*ListWorkflowRevisionsResponse) ProtoMessage

func (*ListWorkflowRevisionsResponse) ProtoMessage()

func (*ListWorkflowRevisionsResponse) ProtoReflect

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

func (*ListWorkflowRevisionsResponse) Reset

func (x *ListWorkflowRevisionsResponse) Reset()

func (*ListWorkflowRevisionsResponse) String

func (x *ListWorkflowRevisionsResponse) String() string

ListWorkflowsRequest

type ListWorkflowsRequest struct {

	// Required. Project and location from which the workflows should be listed.
	// Format: projects/{project}/locations/{location}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of workflows to return per call. The service might return
	// fewer than this value even if not at the end of the collection. If a value
	// is not specified, a default value of 500 is used. The maximum permitted
	// value is 1000 and values greater than 1000 are coerced down to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListWorkflows` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListWorkflows` must
	// match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter to restrict results to specific workflows.
	// For details, see AIP-160.
	//
	// For example, if you are using the Google APIs Explorer:
	//
	// `state="SUCCEEDED"`
	//
	// or
	//
	// `createTime>"2023-08-01" AND state="FAILED"`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Comma-separated list of fields that specify the order of the results.
	// Default sorting order for a field is ascending. To specify descending order
	// for a field, append a "desc" suffix.
	// If not specified, the results are returned in an unspecified order.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method.

func (*ListWorkflowsRequest) Descriptor

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

Deprecated: Use ListWorkflowsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowsRequest) GetFilter

func (x *ListWorkflowsRequest) GetFilter() string

func (*ListWorkflowsRequest) GetOrderBy

func (x *ListWorkflowsRequest) GetOrderBy() string

func (*ListWorkflowsRequest) GetPageSize

func (x *ListWorkflowsRequest) GetPageSize() int32

func (*ListWorkflowsRequest) GetPageToken

func (x *ListWorkflowsRequest) GetPageToken() string

func (*ListWorkflowsRequest) GetParent

func (x *ListWorkflowsRequest) GetParent() string

func (*ListWorkflowsRequest) ProtoMessage

func (*ListWorkflowsRequest) ProtoMessage()

func (*ListWorkflowsRequest) ProtoReflect

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

func (*ListWorkflowsRequest) Reset

func (x *ListWorkflowsRequest) Reset()

func (*ListWorkflowsRequest) String

func (x *ListWorkflowsRequest) String() string

ListWorkflowsResponse

type ListWorkflowsResponse struct {

	// The workflows that match the request.
	Workflows []*Workflow `protobuf:"bytes,1,rep,name=workflows,proto3" json:"workflows,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"`
	// Unreachable resources.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method.

func (*ListWorkflowsResponse) Descriptor

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

Deprecated: Use ListWorkflowsResponse.ProtoReflect.Descriptor instead.

func (*ListWorkflowsResponse) GetNextPageToken

func (x *ListWorkflowsResponse) GetNextPageToken() string

func (*ListWorkflowsResponse) GetUnreachable

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

func (*ListWorkflowsResponse) GetWorkflows

func (x *ListWorkflowsResponse) GetWorkflows() []*Workflow

func (*ListWorkflowsResponse) ProtoMessage

func (*ListWorkflowsResponse) ProtoMessage()

func (*ListWorkflowsResponse) ProtoReflect

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

func (*ListWorkflowsResponse) Reset

func (x *ListWorkflowsResponse) Reset()

func (*ListWorkflowsResponse) String

func (x *ListWorkflowsResponse) String() string

OperationMetadata

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"`
	// API version used to start the operation.
	ApiVersion string `protobuf:"bytes,5,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

UnimplementedWorkflowsServer

type UnimplementedWorkflowsServer struct {
}

UnimplementedWorkflowsServer should be embedded to have forward compatible implementations.

func (UnimplementedWorkflowsServer) CreateWorkflow

func (UnimplementedWorkflowsServer) CreateWorkflow(context.Context, *CreateWorkflowRequest) (*longrunningpb.Operation, error)

func (UnimplementedWorkflowsServer) DeleteWorkflow

func (UnimplementedWorkflowsServer) DeleteWorkflow(context.Context, *DeleteWorkflowRequest) (*longrunningpb.Operation, error)

func (UnimplementedWorkflowsServer) GetWorkflow

func (UnimplementedWorkflowsServer) GetWorkflow(context.Context, *GetWorkflowRequest) (*Workflow, error)

func (UnimplementedWorkflowsServer) ListWorkflowRevisions

func (UnimplementedWorkflowsServer) ListWorkflowRevisions(context.Context, *ListWorkflowRevisionsRequest) (*ListWorkflowRevisionsResponse, error)

func (UnimplementedWorkflowsServer) ListWorkflows

func (UnimplementedWorkflowsServer) ListWorkflows(context.Context, *ListWorkflowsRequest) (*ListWorkflowsResponse, error)

func (UnimplementedWorkflowsServer) UpdateWorkflow

func (UnimplementedWorkflowsServer) UpdateWorkflow(context.Context, *UpdateWorkflowRequest) (*longrunningpb.Operation, error)

UnsafeWorkflowsServer

type UnsafeWorkflowsServer interface {
	// contains filtered or unexported methods
}

UnsafeWorkflowsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WorkflowsServer will result in compilation errors.

UpdateWorkflowRequest

type UpdateWorkflowRequest struct {

	// Required. Workflow to be updated.
	Workflow *Workflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// List of fields to be updated. If not present, the entire workflow
	// 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
}

Request for the [UpdateWorkflow][google.cloud.workflows.v1.Workflows.UpdateWorkflow] method.

func (*UpdateWorkflowRequest) Descriptor

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

Deprecated: Use UpdateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*UpdateWorkflowRequest) GetUpdateMask

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

func (*UpdateWorkflowRequest) GetWorkflow

func (x *UpdateWorkflowRequest) GetWorkflow() *Workflow

func (*UpdateWorkflowRequest) ProtoMessage

func (*UpdateWorkflowRequest) ProtoMessage()

func (*UpdateWorkflowRequest) ProtoReflect

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

func (*UpdateWorkflowRequest) Reset

func (x *UpdateWorkflowRequest) Reset()

func (*UpdateWorkflowRequest) String

func (x *UpdateWorkflowRequest) String() string

Workflow

type Workflow struct {

	// The resource name of the workflow.
	// Format: projects/{project}/locations/{location}/workflows/{workflow}.
	// This is a workflow-wide field and is not tied to a specific revision.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the workflow provided by the user.
	// Must be at most 1000 Unicode characters long.
	// This is a workflow-wide field and is not tied to a specific revision.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. State of the workflow deployment.
	State Workflow_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.workflows.v1.Workflow_State" json:"state,omitempty"`
	// Output only. The revision of the workflow.
	// A new revision of a workflow is created as a result of updating the
	// following properties of a workflow:
	//
	// - [Service account][google.cloud.workflows.v1.Workflow.service_account]
	// - [Workflow code to be
	// executed][google.cloud.workflows.v1.Workflow.source_contents]
	//
	// The format is "000001-a4d", where the first six characters define
	// the zero-padded revision ordinal number. They are followed by a hyphen and
	// three hexadecimal random characters.
	RevisionId string `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// Output only. The timestamp for when the workflow was created.
	// This is a workflow-wide field and is not tied to a specific revision.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp for when the workflow was last updated.
	// This is a workflow-wide field and is not tied to a specific revision.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The timestamp for the latest revision of the workflow's
	// creation.
	RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
	// Labels associated with this workflow.
	// Labels can contain at most 64 entries. Keys and values can be no longer
	// than 63 characters and can only contain lowercase letters, numeric
	// characters, underscores, and dashes. Label keys must start with a letter.
	// International characters are allowed.
	// This is a workflow-wide field and is not tied to a specific revision.
	Labels map[string]string `protobuf:"bytes,8,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// The service account associated with the latest workflow version.
	// This service account represents the identity of the workflow and determines
	// what permissions the workflow has.
	// Format: projects/{project}/serviceAccounts/{account} or {account}
	//
	// Using `-` as a wildcard for the `{project}` or not providing one at all
	// will infer the project from the account. The `{account}` value can be the
	// `email` address or the `unique_id` of the service account.
	//
	// If not provided, workflow will use the project's default service account.
	// Modifying this field for an existing workflow results in a new workflow
	// revision.
	ServiceAccount string `protobuf:"bytes,9,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Required. Location of the workflow source code.
	// Modifying this field for an existing workflow results in a new workflow
	// revision.
	//
	// Types that are valid to be assigned to SourceCode:
	//
	//	*Workflow_SourceContents
	SourceCode isWorkflow_SourceCode `protobuf_oneof:"source_code"`
	// Optional. The resource name of a KMS crypto key used to encrypt or decrypt
	// the data associated with the workflow.
	//
	// Format:
	// projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}
	//
	// Using `-` as a wildcard for the `{project}` or not providing one at all
	// will infer the project from the account.
	//
	// If not provided, data associated with the workflow will not be
	// CMEK-encrypted.
	CryptoKeyName string `protobuf:"bytes,11,opt,name=crypto_key_name,json=cryptoKeyName,proto3" json:"crypto_key_name,omitempty"`
	// Output only. Error regarding the state of the workflow. For example, this
	// field will have error details if the execution data is unavailable due to
	// revoked KMS key permissions.
	StateError *Workflow_StateError `protobuf:"bytes,12,opt,name=state_error,json=stateError,proto3" json:"state_error,omitempty"`
	// Optional. Describes the level of platform logging to apply to calls and
	// call responses during executions of this workflow. If both the workflow and
	// the execution specify a logging level, the execution level takes
	// precedence.
	CallLogLevel Workflow_CallLogLevel `protobuf:"varint,13,opt,name=call_log_level,json=callLogLevel,proto3,enum=google.cloud.workflows.v1.Workflow_CallLogLevel" json:"call_log_level,omitempty"`
	// Optional. User-defined environment variables associated with this workflow
	// revision. This map has a maximum length of 20. Each string can take up to
	// 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or
	// "WORKFLOWS".
	UserEnvVars map[string]string `protobuf:"bytes,14,rep,name=user_env_vars,json=userEnvVars,proto3" json:"user_env_vars,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// Optional. Describes the execution history level to apply to this workflow.
	ExecutionHistoryLevel ExecutionHistoryLevel `protobuf:"varint,15,opt,name=execution_history_level,json=executionHistoryLevel,proto3,enum=google.cloud.workflows.v1.ExecutionHistoryLevel" json:"execution_history_level,omitempty"`
	// Output only. A list of all KMS crypto keys used to encrypt or decrypt the
	// data associated with the workflow.
	AllKmsKeys []string `protobuf:"bytes,16,rep,name=all_kms_keys,json=allKmsKeys,proto3" json:"all_kms_keys,omitempty"`
	// Output only. A list of all KMS crypto key versions used to encrypt or
	// decrypt the data associated with the workflow.
	AllKmsKeysVersions []string `protobuf:"bytes,17,rep,name=all_kms_keys_versions,json=allKmsKeysVersions,proto3" json:"all_kms_keys_versions,omitempty"`
	// Output only. The resource name of a KMS crypto key version used to encrypt
	// or decrypt the data associated with the workflow.
	//
	// Format:
	// projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
	CryptoKeyVersion string `protobuf:"bytes,18,opt,name=crypto_key_version,json=cryptoKeyVersion,proto3" json:"crypto_key_version,omitempty"`
	// Optional. Input only. Immutable. Tags associated with this workflow.
	Tags map[string]string `protobuf:"bytes,19,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// contains filtered or unexported fields
}

Workflow program to be executed by Workflows.

func (*Workflow) Descriptor

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

Deprecated: Use Workflow.ProtoReflect.Descriptor instead.

func (*Workflow) GetAllKmsKeys

func (x *Workflow) GetAllKmsKeys() []string

func (*Workflow) GetAllKmsKeysVersions

func (x *Workflow) GetAllKmsKeysVersions() []string

func (*Workflow) GetCallLogLevel

func (x *Workflow) GetCallLogLevel() Workflow_CallLogLevel

func (*Workflow) GetCreateTime

func (x *Workflow) GetCreateTime() *timestamppb.Timestamp

func (*Workflow) GetCryptoKeyName

func (x *Workflow) GetCryptoKeyName() string

func (*Workflow) GetCryptoKeyVersion

func (x *Workflow) GetCryptoKeyVersion() string

func (*Workflow) GetDescription

func (x *Workflow) GetDescription() string

func (*Workflow) GetExecutionHistoryLevel

func (x *Workflow) GetExecutionHistoryLevel() ExecutionHistoryLevel

func (*Workflow) GetLabels

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

func (*Workflow) GetName

func (x *Workflow) GetName() string

func (*Workflow) GetRevisionCreateTime

func (x *Workflow) GetRevisionCreateTime() *timestamppb.Timestamp

func (*Workflow) GetRevisionId

func (x *Workflow) GetRevisionId() string

func (*Workflow) GetServiceAccount

func (x *Workflow) GetServiceAccount() string

func (*Workflow) GetSourceCode

func (x *Workflow) GetSourceCode() isWorkflow_SourceCode

func (*Workflow) GetSourceContents

func (x *Workflow) GetSourceContents() string

func (*Workflow) GetState

func (x *Workflow) GetState() Workflow_State

func (*Workflow) GetStateError

func (x *Workflow) GetStateError() *Workflow_StateError

func (*Workflow) GetTags

func (x *Workflow) GetTags() map[string]string

func (*Workflow) GetUpdateTime

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

func (*Workflow) GetUserEnvVars

func (x *Workflow) GetUserEnvVars() map[string]string

func (*Workflow) ProtoMessage

func (*Workflow) ProtoMessage()

func (*Workflow) ProtoReflect

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

func (*Workflow) Reset

func (x *Workflow) Reset()

func (*Workflow) String

func (x *Workflow) String() string

Workflow_CallLogLevel

type Workflow_CallLogLevel int32

Describes the level of platform logging to apply to calls and call responses during workflow executions.

Workflow_CALL_LOG_LEVEL_UNSPECIFIED, Workflow_LOG_ALL_CALLS, Workflow_LOG_ERRORS_ONLY, Workflow_LOG_NONE

const (
	// No call logging level specified.
	Workflow_CALL_LOG_LEVEL_UNSPECIFIED Workflow_CallLogLevel = 0
	// Log all call steps within workflows, all call returns, and all exceptions
	// raised.
	Workflow_LOG_ALL_CALLS Workflow_CallLogLevel = 1
	// Log only exceptions that are raised from call steps within workflows.
	Workflow_LOG_ERRORS_ONLY Workflow_CallLogLevel = 2
	// Explicitly log nothing.
	Workflow_LOG_NONE Workflow_CallLogLevel = 3
)

func (Workflow_CallLogLevel) Descriptor

func (Workflow_CallLogLevel) Descriptor() protoreflect.EnumDescriptor

func (Workflow_CallLogLevel) Enum

func (x Workflow_CallLogLevel) Enum() *Workflow_CallLogLevel

func (Workflow_CallLogLevel) EnumDescriptor

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

Deprecated: Use Workflow_CallLogLevel.Descriptor instead.

func (Workflow_CallLogLevel) Number

func (x Workflow_CallLogLevel) Number() protoreflect.EnumNumber

func (Workflow_CallLogLevel) String

func (x Workflow_CallLogLevel) String() string

func (Workflow_CallLogLevel) Type

func (Workflow_CallLogLevel) Type() protoreflect.EnumType

Workflow_SourceContents

type Workflow_SourceContents struct {
	// Workflow code to be executed. The size limit is 128KB.
	SourceContents string `protobuf:"bytes,10,opt,name=source_contents,json=sourceContents,proto3,oneof"`
}

Workflow_State

type Workflow_State int32

Describes the current state of workflow deployment.

Workflow_STATE_UNSPECIFIED, Workflow_ACTIVE, Workflow_UNAVAILABLE

const (
	// Invalid state.
	Workflow_STATE_UNSPECIFIED Workflow_State = 0
	// The workflow has been deployed successfully and is serving.
	Workflow_ACTIVE Workflow_State = 1
	// Workflow data is unavailable. See the `state_error` field.
	Workflow_UNAVAILABLE Workflow_State = 2
)

func (Workflow_State) Descriptor

func (Workflow_State) Descriptor() protoreflect.EnumDescriptor

func (Workflow_State) Enum

func (x Workflow_State) Enum() *Workflow_State

func (Workflow_State) EnumDescriptor

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

Deprecated: Use Workflow_State.Descriptor instead.

func (Workflow_State) Number

func (x Workflow_State) Number() protoreflect.EnumNumber

func (Workflow_State) String

func (x Workflow_State) String() string

func (Workflow_State) Type

func (Workflow_State) Type() protoreflect.EnumType

Workflow_StateError

type Workflow_StateError struct {

	// Provides specifics about the error.
	Details string `protobuf:"bytes,1,opt,name=details,proto3" json:"details,omitempty"`
	// The type of this state error.
	Type Workflow_StateError_Type `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.workflows.v1.Workflow_StateError_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Describes an error related to the current state of the workflow.

func (*Workflow_StateError) Descriptor

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

Deprecated: Use Workflow_StateError.ProtoReflect.Descriptor instead.

func (*Workflow_StateError) GetDetails

func (x *Workflow_StateError) GetDetails() string

func (*Workflow_StateError) GetType

func (x *Workflow_StateError) GetType() Workflow_StateError_Type

func (*Workflow_StateError) ProtoMessage

func (*Workflow_StateError) ProtoMessage()

func (*Workflow_StateError) ProtoReflect

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

func (*Workflow_StateError) Reset

func (x *Workflow_StateError) Reset()

func (*Workflow_StateError) String

func (x *Workflow_StateError) String() string

Workflow_StateError_Type

type Workflow_StateError_Type int32

Describes the possibled types of a state error.

Workflow_StateError_TYPE_UNSPECIFIED, Workflow_StateError_KMS_ERROR

const (
	// No type specified.
	Workflow_StateError_TYPE_UNSPECIFIED Workflow_StateError_Type = 0
	// Caused by an issue with KMS.
	Workflow_StateError_KMS_ERROR Workflow_StateError_Type = 1
)

func (Workflow_StateError_Type) Descriptor

func (Workflow_StateError_Type) Descriptor() protoreflect.EnumDescriptor

func (Workflow_StateError_Type) Enum

func (x Workflow_StateError_Type) Enum() *Workflow_StateError_Type

func (Workflow_StateError_Type) EnumDescriptor

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

Deprecated: Use Workflow_StateError_Type.Descriptor instead.

func (Workflow_StateError_Type) Number

func (x Workflow_StateError_Type) Number() protoreflect.EnumNumber

func (Workflow_StateError_Type) String

func (x Workflow_StateError_Type) String() string

func (Workflow_StateError_Type) Type

func (Workflow_StateError_Type) Type() protoreflect.EnumType

WorkflowsClient

type WorkflowsClient interface {
	// Lists workflows in a given project and location.
	// The default order is not specified.
	ListWorkflows(ctx context.Context, in *ListWorkflowsRequest, opts ...grpc.CallOption) (*ListWorkflowsResponse, error)
	// Gets details of a single workflow.
	GetWorkflow(ctx context.Context, in *GetWorkflowRequest, opts ...grpc.CallOption) (*Workflow, error)
	// Creates a new workflow. If a workflow with the specified name already
	// exists in the specified project and location, the long running operation
	// returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
	CreateWorkflow(ctx context.Context, in *CreateWorkflowRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a workflow with the specified name.
	// This method also cancels and deletes all running executions of the
	// workflow.
	DeleteWorkflow(ctx context.Context, in *DeleteWorkflowRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an existing workflow.
	// Running this method has no impact on already running executions of the
	// workflow. A new revision of the workflow might be created as a result of a
	// successful update operation. In that case, the new revision is used
	// in new workflow executions.
	UpdateWorkflow(ctx context.Context, in *UpdateWorkflowRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists revisions for a given workflow.
	ListWorkflowRevisions(ctx context.Context, in *ListWorkflowRevisionsRequest, opts ...grpc.CallOption) (*ListWorkflowRevisionsResponse, error)
}

WorkflowsClient is the client API for Workflows service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewWorkflowsClient

func NewWorkflowsClient(cc grpc.ClientConnInterface) WorkflowsClient

WorkflowsServer

type WorkflowsServer interface {
	// Lists workflows in a given project and location.
	// The default order is not specified.
	ListWorkflows(context.Context, *ListWorkflowsRequest) (*ListWorkflowsResponse, error)
	// Gets details of a single workflow.
	GetWorkflow(context.Context, *GetWorkflowRequest) (*Workflow, error)
	// Creates a new workflow. If a workflow with the specified name already
	// exists in the specified project and location, the long running operation
	// returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
	CreateWorkflow(context.Context, *CreateWorkflowRequest) (*longrunningpb.Operation, error)
	// Deletes a workflow with the specified name.
	// This method also cancels and deletes all running executions of the
	// workflow.
	DeleteWorkflow(context.Context, *DeleteWorkflowRequest) (*longrunningpb.Operation, error)
	// Updates an existing workflow.
	// Running this method has no impact on already running executions of the
	// workflow. A new revision of the workflow might be created as a result of a
	// successful update operation. In that case, the new revision is used
	// in new workflow executions.
	UpdateWorkflow(context.Context, *UpdateWorkflowRequest) (*longrunningpb.Operation, error)
	// Lists revisions for a given workflow.
	ListWorkflowRevisions(context.Context, *ListWorkflowRevisionsRequest) (*ListWorkflowRevisionsResponse, error)
}

WorkflowsServer is the server API for Workflows service. All implementations should embed UnimplementedWorkflowsServer for forward compatibility