Documentation ¶
Overview ¶
Package workflowsdata provides Workflows type definitions for CloudEvent data payloads.
Supported CloudEvent Types ¶
- google.cloud.workflows.workflow.v1.created
- google.cloud.workflows.workflow.v1.deleted
- google.cloud.workflows.workflow.v1.updated
Index ¶
- Variables
- type Workflow
- func (*Workflow) Descriptor() ([]byte, []int)deprecated
- func (x *Workflow) GetCreateTime() *timestamppb.Timestamp
- func (x *Workflow) GetDescription() string
- func (x *Workflow) GetLabels() map[string]string
- func (x *Workflow) GetName() string
- func (x *Workflow) GetRevisionCreateTime() *timestamppb.Timestamp
- func (x *Workflow) GetRevisionId() string
- func (x *Workflow) GetServiceAccount() string
- func (m *Workflow) GetSourceCode() isWorkflow_SourceCode
- func (x *Workflow) GetSourceContents() string
- func (x *Workflow) GetState() Workflow_State
- func (x *Workflow) GetUpdateTime() *timestamppb.Timestamp
- func (*Workflow) ProtoMessage()
- func (x *Workflow) ProtoReflect() protoreflect.Message
- func (x *Workflow) Reset()
- func (x *Workflow) String() string
- type WorkflowEventData
- func (*WorkflowEventData) Descriptor() ([]byte, []int)deprecated
- func (x *WorkflowEventData) GetPayload() *Workflow
- func (*WorkflowEventData) ProtoMessage()
- func (x *WorkflowEventData) ProtoReflect() protoreflect.Message
- func (x *WorkflowEventData) Reset()
- func (x *WorkflowEventData) String() string
- type Workflow_SourceContents
- type Workflow_State
- func (Workflow_State) Descriptor() protoreflect.EnumDescriptor
- func (x Workflow_State) Enum() *Workflow_State
- func (Workflow_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x Workflow_State) Number() protoreflect.EnumNumber
- func (x Workflow_State) String() string
- func (Workflow_State) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
View Source
var ( Workflow_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "ACTIVE", } Workflow_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "ACTIVE": 1, } )
Enum value maps for Workflow_State.
View Source
var File_cloud_workflows_v1_data_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Workflow ¶
type Workflow struct { // The resource name of the workflow. // Format: projects/{project}/locations/{location}/workflows/{workflow} 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. 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.events.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 6 characters define // the zero-padded revision ordinal number. They are followed by a hyphen and // 3 hexadecimal random characters. RevisionId string `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"` // Output only. The timestamp of when the workflow was created. CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` // Output only. The last update timestamp of the workflow. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // Output only. The timestamp that the latest revision of the workflow // was created. 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. Labels map[string]string `` /* 153-byte string literal not displayed */ // 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 assignable to SourceCode: // // *Workflow_SourceContents SourceCode isWorkflow_SourceCode `protobuf_oneof:"source_code"` // contains filtered or unexported fields }
Workflow program to be executed by Workflows.
func (*Workflow) Descriptor
deprecated
func (*Workflow) GetCreateTime ¶
func (x *Workflow) GetCreateTime() *timestamppb.Timestamp
func (*Workflow) GetDescription ¶
func (*Workflow) GetRevisionCreateTime ¶
func (x *Workflow) GetRevisionCreateTime() *timestamppb.Timestamp
func (*Workflow) GetRevisionId ¶
func (*Workflow) GetServiceAccount ¶
func (*Workflow) GetSourceCode ¶
func (m *Workflow) GetSourceCode() isWorkflow_SourceCode
func (*Workflow) GetSourceContents ¶
func (*Workflow) GetState ¶
func (x *Workflow) GetState() Workflow_State
func (*Workflow) GetUpdateTime ¶
func (x *Workflow) GetUpdateTime() *timestamppb.Timestamp
func (*Workflow) ProtoMessage ¶
func (*Workflow) ProtoMessage()
func (*Workflow) ProtoReflect ¶
func (x *Workflow) ProtoReflect() protoreflect.Message
type WorkflowEventData ¶
type WorkflowEventData struct { // Optional. The Workflow event payload. Unset for deletion events. Payload *Workflow `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"` // contains filtered or unexported fields }
The data within all Workflow events.
func (*WorkflowEventData) Descriptor
deprecated
func (*WorkflowEventData) Descriptor() ([]byte, []int)
Deprecated: Use WorkflowEventData.ProtoReflect.Descriptor instead.
func (*WorkflowEventData) GetPayload ¶
func (x *WorkflowEventData) GetPayload() *Workflow
func (*WorkflowEventData) ProtoMessage ¶
func (*WorkflowEventData) ProtoMessage()
func (*WorkflowEventData) ProtoReflect ¶
func (x *WorkflowEventData) ProtoReflect() protoreflect.Message
func (*WorkflowEventData) Reset ¶
func (x *WorkflowEventData) Reset()
func (*WorkflowEventData) String ¶
func (x *WorkflowEventData) String() string
type 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"` }
type Workflow_State ¶
type Workflow_State int32
Describes the current state of workflow deployment. More states may be added in the future.
const ( // Invalid state. Workflow_STATE_UNSPECIFIED Workflow_State = 0 // The workflow has been deployed successfully and is serving. Workflow_ACTIVE Workflow_State = 1 )
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
deprecated
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
Click to show internal directories.
Click to hide internal directories.