Documentation ¶
Index ¶
- Variables
- func RegisterExecutionsServer(s *grpc.Server, srv ExecutionsServer)
- type CancelExecutionRequest
- func (*CancelExecutionRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CancelExecutionRequest) GetName() string
- func (*CancelExecutionRequest) ProtoMessage()
- func (x *CancelExecutionRequest) ProtoReflect() protoreflect.Message
- func (x *CancelExecutionRequest) Reset()
- func (x *CancelExecutionRequest) String() string
- type CreateExecutionRequest
- func (*CreateExecutionRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateExecutionRequest) GetExecution() *Execution
- func (x *CreateExecutionRequest) GetParent() string
- func (*CreateExecutionRequest) ProtoMessage()
- func (x *CreateExecutionRequest) ProtoReflect() protoreflect.Message
- func (x *CreateExecutionRequest) Reset()
- func (x *CreateExecutionRequest) String() string
- type Execution
- func (*Execution) Descriptor() ([]byte, []int)deprecated
- func (x *Execution) GetArgument() string
- func (x *Execution) GetCallLogLevel() Execution_CallLogLevel
- func (x *Execution) GetDuration() *durationpb.Duration
- func (x *Execution) GetEndTime() *timestamppb.Timestamp
- func (x *Execution) GetError() *Execution_Error
- func (x *Execution) GetLabels() map[string]string
- func (x *Execution) GetName() string
- func (x *Execution) GetResult() string
- func (x *Execution) GetStartTime() *timestamppb.Timestamp
- func (x *Execution) GetState() Execution_State
- func (x *Execution) GetStateError() *Execution_StateError
- func (x *Execution) GetStatus() *Execution_Status
- func (x *Execution) GetWorkflowRevisionId() string
- func (*Execution) ProtoMessage()
- func (x *Execution) ProtoReflect() protoreflect.Message
- func (x *Execution) Reset()
- func (x *Execution) String() string
- type ExecutionView
- func (ExecutionView) Descriptor() protoreflect.EnumDescriptor
- func (x ExecutionView) Enum() *ExecutionView
- func (ExecutionView) EnumDescriptor() ([]byte, []int)deprecated
- func (x ExecutionView) Number() protoreflect.EnumNumber
- func (x ExecutionView) String() string
- func (ExecutionView) Type() protoreflect.EnumType
- type Execution_CallLogLevel
- func (Execution_CallLogLevel) Descriptor() protoreflect.EnumDescriptor
- func (x Execution_CallLogLevel) Enum() *Execution_CallLogLevel
- func (Execution_CallLogLevel) EnumDescriptor() ([]byte, []int)deprecated
- func (x Execution_CallLogLevel) Number() protoreflect.EnumNumber
- func (x Execution_CallLogLevel) String() string
- func (Execution_CallLogLevel) Type() protoreflect.EnumType
- type Execution_Error
- func (*Execution_Error) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_Error) GetContext() string
- func (x *Execution_Error) GetPayload() string
- func (x *Execution_Error) GetStackTrace() *Execution_StackTrace
- func (*Execution_Error) ProtoMessage()
- func (x *Execution_Error) ProtoReflect() protoreflect.Message
- func (x *Execution_Error) Reset()
- func (x *Execution_Error) String() string
- type Execution_StackTrace
- func (*Execution_StackTrace) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_StackTrace) GetElements() []*Execution_StackTraceElement
- func (*Execution_StackTrace) ProtoMessage()
- func (x *Execution_StackTrace) ProtoReflect() protoreflect.Message
- func (x *Execution_StackTrace) Reset()
- func (x *Execution_StackTrace) String() string
- type Execution_StackTraceElement
- func (*Execution_StackTraceElement) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_StackTraceElement) GetPosition() *Execution_StackTraceElement_Position
- func (x *Execution_StackTraceElement) GetRoutine() string
- func (x *Execution_StackTraceElement) GetStep() string
- func (*Execution_StackTraceElement) ProtoMessage()
- func (x *Execution_StackTraceElement) ProtoReflect() protoreflect.Message
- func (x *Execution_StackTraceElement) Reset()
- func (x *Execution_StackTraceElement) String() string
- type Execution_StackTraceElement_Position
- func (*Execution_StackTraceElement_Position) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_StackTraceElement_Position) GetColumn() int64
- func (x *Execution_StackTraceElement_Position) GetLength() int64
- func (x *Execution_StackTraceElement_Position) GetLine() int64
- func (*Execution_StackTraceElement_Position) ProtoMessage()
- func (x *Execution_StackTraceElement_Position) ProtoReflect() protoreflect.Message
- func (x *Execution_StackTraceElement_Position) Reset()
- func (x *Execution_StackTraceElement_Position) String() string
- type Execution_State
- func (Execution_State) Descriptor() protoreflect.EnumDescriptor
- func (x Execution_State) Enum() *Execution_State
- func (Execution_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x Execution_State) Number() protoreflect.EnumNumber
- func (x Execution_State) String() string
- func (Execution_State) Type() protoreflect.EnumType
- type Execution_StateError
- func (*Execution_StateError) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_StateError) GetDetails() string
- func (x *Execution_StateError) GetType() Execution_StateError_Type
- func (*Execution_StateError) ProtoMessage()
- func (x *Execution_StateError) ProtoReflect() protoreflect.Message
- func (x *Execution_StateError) Reset()
- func (x *Execution_StateError) String() string
- type Execution_StateError_Type
- func (Execution_StateError_Type) Descriptor() protoreflect.EnumDescriptor
- func (x Execution_StateError_Type) Enum() *Execution_StateError_Type
- func (Execution_StateError_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x Execution_StateError_Type) Number() protoreflect.EnumNumber
- func (x Execution_StateError_Type) String() string
- func (Execution_StateError_Type) Type() protoreflect.EnumType
- type Execution_Status
- func (*Execution_Status) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_Status) GetCurrentSteps() []*Execution_Status_Step
- func (*Execution_Status) ProtoMessage()
- func (x *Execution_Status) ProtoReflect() protoreflect.Message
- func (x *Execution_Status) Reset()
- func (x *Execution_Status) String() string
- type Execution_Status_Step
- func (*Execution_Status_Step) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_Status_Step) GetRoutine() string
- func (x *Execution_Status_Step) GetStep() string
- func (*Execution_Status_Step) ProtoMessage()
- func (x *Execution_Status_Step) ProtoReflect() protoreflect.Message
- func (x *Execution_Status_Step) Reset()
- func (x *Execution_Status_Step) String() string
- type ExecutionsClient
- type ExecutionsServer
- type GetExecutionRequest
- func (*GetExecutionRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetExecutionRequest) GetName() string
- func (x *GetExecutionRequest) GetView() ExecutionView
- func (*GetExecutionRequest) ProtoMessage()
- func (x *GetExecutionRequest) ProtoReflect() protoreflect.Message
- func (x *GetExecutionRequest) Reset()
- func (x *GetExecutionRequest) String() string
- type ListExecutionsRequest
- func (*ListExecutionsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListExecutionsRequest) GetFilter() string
- func (x *ListExecutionsRequest) GetOrderBy() string
- func (x *ListExecutionsRequest) GetPageSize() int32
- func (x *ListExecutionsRequest) GetPageToken() string
- func (x *ListExecutionsRequest) GetParent() string
- func (x *ListExecutionsRequest) GetView() ExecutionView
- func (*ListExecutionsRequest) ProtoMessage()
- func (x *ListExecutionsRequest) ProtoReflect() protoreflect.Message
- func (x *ListExecutionsRequest) Reset()
- func (x *ListExecutionsRequest) String() string
- type ListExecutionsResponse
- func (*ListExecutionsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListExecutionsResponse) GetExecutions() []*Execution
- func (x *ListExecutionsResponse) GetNextPageToken() string
- func (*ListExecutionsResponse) ProtoMessage()
- func (x *ListExecutionsResponse) ProtoReflect() protoreflect.Message
- func (x *ListExecutionsResponse) Reset()
- func (x *ListExecutionsResponse) String() string
- type UnimplementedExecutionsServer
- func (*UnimplementedExecutionsServer) CancelExecution(context.Context, *CancelExecutionRequest) (*Execution, error)
- func (*UnimplementedExecutionsServer) CreateExecution(context.Context, *CreateExecutionRequest) (*Execution, error)
- func (*UnimplementedExecutionsServer) GetExecution(context.Context, *GetExecutionRequest) (*Execution, error)
- func (*UnimplementedExecutionsServer) ListExecutions(context.Context, *ListExecutionsRequest) (*ListExecutionsResponse, error)
Constants ¶
This section is empty.
Variables ¶
var ( ExecutionView_name = map[int32]string{ 0: "EXECUTION_VIEW_UNSPECIFIED", 1: "BASIC", 2: "FULL", } ExecutionView_value = map[string]int32{ "EXECUTION_VIEW_UNSPECIFIED": 0, "BASIC": 1, "FULL": 2, } )
Enum value maps for ExecutionView.
var ( Execution_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "ACTIVE", 2: "SUCCEEDED", 3: "FAILED", 4: "CANCELLED", 5: "UNAVAILABLE", 6: "QUEUED", } Execution_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "ACTIVE": 1, "SUCCEEDED": 2, "FAILED": 3, "CANCELLED": 4, "UNAVAILABLE": 5, "QUEUED": 6, } )
Enum value maps for Execution_State.
var ( Execution_CallLogLevel_name = map[int32]string{ 0: "CALL_LOG_LEVEL_UNSPECIFIED", 1: "LOG_ALL_CALLS", 2: "LOG_ERRORS_ONLY", 3: "LOG_NONE", } Execution_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 Execution_CallLogLevel.
var ( Execution_StateError_Type_name = map[int32]string{ 0: "TYPE_UNSPECIFIED", 1: "KMS_ERROR", } Execution_StateError_Type_value = map[string]int32{ "TYPE_UNSPECIFIED": 0, "KMS_ERROR": 1, } )
Enum value maps for Execution_StateError_Type.
var File_google_cloud_workflows_executions_v1_executions_proto protoreflect.FileDescriptor
Functions ¶
func RegisterExecutionsServer ¶
func RegisterExecutionsServer(s *grpc.Server, srv ExecutionsServer)
Types ¶
type CancelExecutionRequest ¶
type CancelExecutionRequest struct { // Required. Name of the execution to be cancelled. // Format: // projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
Request for the [CancelExecution][google.cloud.workflows.executions.v1.Executions.CancelExecution] method.
func (*CancelExecutionRequest) Descriptor
deprecated
func (*CancelExecutionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CancelExecutionRequest.ProtoReflect.Descriptor instead.
func (*CancelExecutionRequest) GetName ¶
func (x *CancelExecutionRequest) GetName() string
func (*CancelExecutionRequest) ProtoMessage ¶
func (*CancelExecutionRequest) ProtoMessage()
func (*CancelExecutionRequest) ProtoReflect ¶
func (x *CancelExecutionRequest) ProtoReflect() protoreflect.Message
func (*CancelExecutionRequest) Reset ¶
func (x *CancelExecutionRequest) Reset()
func (*CancelExecutionRequest) String ¶
func (x *CancelExecutionRequest) String() string
type CreateExecutionRequest ¶
type CreateExecutionRequest struct { // Required. Name of the workflow for which an execution should be created. // Format: projects/{project}/locations/{location}/workflows/{workflow} // The latest revision of the workflow will be used. Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // Required. Execution to be created. Execution *Execution `protobuf:"bytes,2,opt,name=execution,proto3" json:"execution,omitempty"` // contains filtered or unexported fields }
Request for the [CreateExecution][google.cloud.workflows.executions.v1.Executions.CreateExecution] method.
func (*CreateExecutionRequest) Descriptor
deprecated
func (*CreateExecutionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateExecutionRequest.ProtoReflect.Descriptor instead.
func (*CreateExecutionRequest) GetExecution ¶
func (x *CreateExecutionRequest) GetExecution() *Execution
func (*CreateExecutionRequest) GetParent ¶
func (x *CreateExecutionRequest) GetParent() string
func (*CreateExecutionRequest) ProtoMessage ¶
func (*CreateExecutionRequest) ProtoMessage()
func (*CreateExecutionRequest) ProtoReflect ¶
func (x *CreateExecutionRequest) ProtoReflect() protoreflect.Message
func (*CreateExecutionRequest) Reset ¶
func (x *CreateExecutionRequest) Reset()
func (*CreateExecutionRequest) String ¶
func (x *CreateExecutionRequest) String() string
type Execution ¶
type Execution struct { // Output only. The resource name of the execution. // Format: // projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Output only. Marks the beginning of execution. StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // Output only. Marks the end of execution, successful or not. EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // Output only. Measures the duration of the execution. Duration *durationpb.Duration `protobuf:"bytes,12,opt,name=duration,proto3" json:"duration,omitempty"` // Output only. Current state of the execution. State Execution_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.workflows.executions.v1.Execution_State" json:"state,omitempty"` // Input parameters of the execution represented as a JSON string. // The size limit is 32KB. // // *Note*: If you are using the REST API directly to run your workflow, you // must escape any JSON string value of `argument`. Example: // `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'` Argument string `protobuf:"bytes,5,opt,name=argument,proto3" json:"argument,omitempty"` // Output only. Output of the execution represented as a JSON string. The // value can only be present if the execution's state is `SUCCEEDED`. Result string `protobuf:"bytes,6,opt,name=result,proto3" json:"result,omitempty"` // Output only. The error which caused the execution to finish prematurely. // The value is only present if the execution's state is `FAILED` // or `CANCELLED`. Error *Execution_Error `protobuf:"bytes,7,opt,name=error,proto3" json:"error,omitempty"` // Output only. Revision of the workflow this execution is using. WorkflowRevisionId string `protobuf:"bytes,8,opt,name=workflow_revision_id,json=workflowRevisionId,proto3" json:"workflow_revision_id,omitempty"` // The call logging level associated to this execution. CallLogLevel Execution_CallLogLevel `` /* 165-byte string literal not displayed */ // Output only. Status tracks the current steps and progress data of this // execution. Status *Execution_Status `protobuf:"bytes,10,opt,name=status,proto3" json:"status,omitempty"` // Labels associated with this execution. // 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. // By default, labels are inherited from the workflow but are overridden by // any labels associated with the execution. Labels map[string]string `` /* 154-byte string literal not displayed */ // Output only. Error regarding the state of the Execution resource. For // example, this field will have error details if the execution data is // unavailable due to revoked KMS key permissions. StateError *Execution_StateError `protobuf:"bytes,13,opt,name=state_error,json=stateError,proto3" json:"state_error,omitempty"` // contains filtered or unexported fields }
A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows).
func (*Execution) Descriptor
deprecated
func (*Execution) GetArgument ¶
func (*Execution) GetCallLogLevel ¶
func (x *Execution) GetCallLogLevel() Execution_CallLogLevel
func (*Execution) GetDuration ¶ added in v1.12.0
func (x *Execution) GetDuration() *durationpb.Duration
func (*Execution) GetEndTime ¶
func (x *Execution) GetEndTime() *timestamppb.Timestamp
func (*Execution) GetError ¶
func (x *Execution) GetError() *Execution_Error
func (*Execution) GetStartTime ¶
func (x *Execution) GetStartTime() *timestamppb.Timestamp
func (*Execution) GetState ¶
func (x *Execution) GetState() Execution_State
func (*Execution) GetStateError ¶ added in v1.12.0
func (x *Execution) GetStateError() *Execution_StateError
func (*Execution) GetStatus ¶ added in v1.12.0
func (x *Execution) GetStatus() *Execution_Status
func (*Execution) GetWorkflowRevisionId ¶
func (*Execution) ProtoMessage ¶
func (*Execution) ProtoMessage()
func (*Execution) ProtoReflect ¶
func (x *Execution) ProtoReflect() protoreflect.Message
type ExecutionView ¶
type ExecutionView int32
Defines possible views for execution resource.
const ( // The default / unset value. ExecutionView_EXECUTION_VIEW_UNSPECIFIED ExecutionView = 0 // Includes only basic metadata about the execution. // The following fields are returned: name, start_time, end_time, duration, // state, and workflow_revision_id. ExecutionView_BASIC ExecutionView = 1 // Includes all data. ExecutionView_FULL ExecutionView = 2 )
func (ExecutionView) Descriptor ¶
func (ExecutionView) Descriptor() protoreflect.EnumDescriptor
func (ExecutionView) Enum ¶
func (x ExecutionView) Enum() *ExecutionView
func (ExecutionView) EnumDescriptor
deprecated
func (ExecutionView) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExecutionView.Descriptor instead.
func (ExecutionView) Number ¶
func (x ExecutionView) Number() protoreflect.EnumNumber
func (ExecutionView) String ¶
func (x ExecutionView) String() string
func (ExecutionView) Type ¶
func (ExecutionView) Type() protoreflect.EnumType
type Execution_CallLogLevel ¶
type Execution_CallLogLevel int32
Describes the level of platform logging to apply to calls and call responses during workflow executions.
const ( // No call logging level specified. Execution_CALL_LOG_LEVEL_UNSPECIFIED Execution_CallLogLevel = 0 // Log all call steps within workflows, all call returns, and all exceptions // raised. Execution_LOG_ALL_CALLS Execution_CallLogLevel = 1 // Log only exceptions that are raised from call steps within workflows. Execution_LOG_ERRORS_ONLY Execution_CallLogLevel = 2 // Explicitly log nothing. Execution_LOG_NONE Execution_CallLogLevel = 3 )
func (Execution_CallLogLevel) Descriptor ¶
func (Execution_CallLogLevel) Descriptor() protoreflect.EnumDescriptor
func (Execution_CallLogLevel) Enum ¶
func (x Execution_CallLogLevel) Enum() *Execution_CallLogLevel
func (Execution_CallLogLevel) EnumDescriptor
deprecated
func (Execution_CallLogLevel) EnumDescriptor() ([]byte, []int)
Deprecated: Use Execution_CallLogLevel.Descriptor instead.
func (Execution_CallLogLevel) Number ¶
func (x Execution_CallLogLevel) Number() protoreflect.EnumNumber
func (Execution_CallLogLevel) String ¶
func (x Execution_CallLogLevel) String() string
func (Execution_CallLogLevel) Type ¶
func (Execution_CallLogLevel) Type() protoreflect.EnumType
type Execution_Error ¶
type Execution_Error struct { // Error message and data returned represented as a JSON string. Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"` // Human-readable stack trace string. Context string `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"` // Stack trace with detailed information of where error was generated. StackTrace *Execution_StackTrace `protobuf:"bytes,3,opt,name=stack_trace,json=stackTrace,proto3" json:"stack_trace,omitempty"` // contains filtered or unexported fields }
Error describes why the execution was abnormally terminated.
func (*Execution_Error) Descriptor
deprecated
func (*Execution_Error) Descriptor() ([]byte, []int)
Deprecated: Use Execution_Error.ProtoReflect.Descriptor instead.
func (*Execution_Error) GetContext ¶
func (x *Execution_Error) GetContext() string
func (*Execution_Error) GetPayload ¶
func (x *Execution_Error) GetPayload() string
func (*Execution_Error) GetStackTrace ¶
func (x *Execution_Error) GetStackTrace() *Execution_StackTrace
func (*Execution_Error) ProtoMessage ¶
func (*Execution_Error) ProtoMessage()
func (*Execution_Error) ProtoReflect ¶
func (x *Execution_Error) ProtoReflect() protoreflect.Message
func (*Execution_Error) Reset ¶
func (x *Execution_Error) Reset()
func (*Execution_Error) String ¶
func (x *Execution_Error) String() string
type Execution_StackTrace ¶
type Execution_StackTrace struct { // An array of stack elements. Elements []*Execution_StackTraceElement `protobuf:"bytes,1,rep,name=elements,proto3" json:"elements,omitempty"` // contains filtered or unexported fields }
A collection of stack elements (frames) where an error occurred.
func (*Execution_StackTrace) Descriptor
deprecated
func (*Execution_StackTrace) Descriptor() ([]byte, []int)
Deprecated: Use Execution_StackTrace.ProtoReflect.Descriptor instead.
func (*Execution_StackTrace) GetElements ¶
func (x *Execution_StackTrace) GetElements() []*Execution_StackTraceElement
func (*Execution_StackTrace) ProtoMessage ¶
func (*Execution_StackTrace) ProtoMessage()
func (*Execution_StackTrace) ProtoReflect ¶
func (x *Execution_StackTrace) ProtoReflect() protoreflect.Message
func (*Execution_StackTrace) Reset ¶
func (x *Execution_StackTrace) Reset()
func (*Execution_StackTrace) String ¶
func (x *Execution_StackTrace) String() string
type Execution_StackTraceElement ¶
type Execution_StackTraceElement struct { // The step the error occurred at. Step string `protobuf:"bytes,1,opt,name=step,proto3" json:"step,omitempty"` // The routine where the error occurred. Routine string `protobuf:"bytes,2,opt,name=routine,proto3" json:"routine,omitempty"` // The source position information of the stack trace element. Position *Execution_StackTraceElement_Position `protobuf:"bytes,3,opt,name=position,proto3" json:"position,omitempty"` // contains filtered or unexported fields }
A single stack element (frame) where an error occurred.
func (*Execution_StackTraceElement) Descriptor
deprecated
func (*Execution_StackTraceElement) Descriptor() ([]byte, []int)
Deprecated: Use Execution_StackTraceElement.ProtoReflect.Descriptor instead.
func (*Execution_StackTraceElement) GetPosition ¶
func (x *Execution_StackTraceElement) GetPosition() *Execution_StackTraceElement_Position
func (*Execution_StackTraceElement) GetRoutine ¶
func (x *Execution_StackTraceElement) GetRoutine() string
func (*Execution_StackTraceElement) GetStep ¶
func (x *Execution_StackTraceElement) GetStep() string
func (*Execution_StackTraceElement) ProtoMessage ¶
func (*Execution_StackTraceElement) ProtoMessage()
func (*Execution_StackTraceElement) ProtoReflect ¶
func (x *Execution_StackTraceElement) ProtoReflect() protoreflect.Message
func (*Execution_StackTraceElement) Reset ¶
func (x *Execution_StackTraceElement) Reset()
func (*Execution_StackTraceElement) String ¶
func (x *Execution_StackTraceElement) String() string
type Execution_StackTraceElement_Position ¶
type Execution_StackTraceElement_Position struct { // The source code line number the current instruction was generated from. Line int64 `protobuf:"varint,1,opt,name=line,proto3" json:"line,omitempty"` // The source code column position (of the line) the current instruction // was generated from. Column int64 `protobuf:"varint,2,opt,name=column,proto3" json:"column,omitempty"` // The number of bytes of source code making up this stack trace element. Length int64 `protobuf:"varint,3,opt,name=length,proto3" json:"length,omitempty"` // contains filtered or unexported fields }
Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes.
func (*Execution_StackTraceElement_Position) Descriptor
deprecated
func (*Execution_StackTraceElement_Position) Descriptor() ([]byte, []int)
Deprecated: Use Execution_StackTraceElement_Position.ProtoReflect.Descriptor instead.
func (*Execution_StackTraceElement_Position) GetColumn ¶
func (x *Execution_StackTraceElement_Position) GetColumn() int64
func (*Execution_StackTraceElement_Position) GetLength ¶
func (x *Execution_StackTraceElement_Position) GetLength() int64
func (*Execution_StackTraceElement_Position) GetLine ¶
func (x *Execution_StackTraceElement_Position) GetLine() int64
func (*Execution_StackTraceElement_Position) ProtoMessage ¶
func (*Execution_StackTraceElement_Position) ProtoMessage()
func (*Execution_StackTraceElement_Position) ProtoReflect ¶
func (x *Execution_StackTraceElement_Position) ProtoReflect() protoreflect.Message
func (*Execution_StackTraceElement_Position) Reset ¶
func (x *Execution_StackTraceElement_Position) Reset()
func (*Execution_StackTraceElement_Position) String ¶
func (x *Execution_StackTraceElement_Position) String() string
type Execution_State ¶
type Execution_State int32
Describes the current state of the execution. More states might be added in the future.
const ( // Invalid state. Execution_STATE_UNSPECIFIED Execution_State = 0 // The execution is in progress. Execution_ACTIVE Execution_State = 1 // The execution finished successfully. Execution_SUCCEEDED Execution_State = 2 // The execution failed with an error. Execution_FAILED Execution_State = 3 // The execution was stopped intentionally. Execution_CANCELLED Execution_State = 4 // Execution data is unavailable. See the `state_error` field. Execution_UNAVAILABLE Execution_State = 5 // Request has been placed in the backlog for processing at a later time. Execution_QUEUED Execution_State = 6 )
func (Execution_State) Descriptor ¶
func (Execution_State) Descriptor() protoreflect.EnumDescriptor
func (Execution_State) Enum ¶
func (x Execution_State) Enum() *Execution_State
func (Execution_State) EnumDescriptor
deprecated
func (Execution_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Execution_State.Descriptor instead.
func (Execution_State) Number ¶
func (x Execution_State) Number() protoreflect.EnumNumber
func (Execution_State) String ¶
func (x Execution_State) String() string
func (Execution_State) Type ¶
func (Execution_State) Type() protoreflect.EnumType
type Execution_StateError ¶ added in v1.12.0
type Execution_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 Execution_StateError_Type `` /* 130-byte string literal not displayed */ // contains filtered or unexported fields }
Describes an error related to the current state of the Execution resource.
func (*Execution_StateError) Descriptor
deprecated
added in
v1.12.0
func (*Execution_StateError) Descriptor() ([]byte, []int)
Deprecated: Use Execution_StateError.ProtoReflect.Descriptor instead.
func (*Execution_StateError) GetDetails ¶ added in v1.12.0
func (x *Execution_StateError) GetDetails() string
func (*Execution_StateError) GetType ¶ added in v1.12.0
func (x *Execution_StateError) GetType() Execution_StateError_Type
func (*Execution_StateError) ProtoMessage ¶ added in v1.12.0
func (*Execution_StateError) ProtoMessage()
func (*Execution_StateError) ProtoReflect ¶ added in v1.12.0
func (x *Execution_StateError) ProtoReflect() protoreflect.Message
func (*Execution_StateError) Reset ¶ added in v1.12.0
func (x *Execution_StateError) Reset()
func (*Execution_StateError) String ¶ added in v1.12.0
func (x *Execution_StateError) String() string
type Execution_StateError_Type ¶ added in v1.12.0
type Execution_StateError_Type int32
Describes the possible types of a state error.
const ( // No type specified. Execution_StateError_TYPE_UNSPECIFIED Execution_StateError_Type = 0 // Caused by an issue with KMS. Execution_StateError_KMS_ERROR Execution_StateError_Type = 1 )
func (Execution_StateError_Type) Descriptor ¶ added in v1.12.0
func (Execution_StateError_Type) Descriptor() protoreflect.EnumDescriptor
func (Execution_StateError_Type) Enum ¶ added in v1.12.0
func (x Execution_StateError_Type) Enum() *Execution_StateError_Type
func (Execution_StateError_Type) EnumDescriptor
deprecated
added in
v1.12.0
func (Execution_StateError_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use Execution_StateError_Type.Descriptor instead.
func (Execution_StateError_Type) Number ¶ added in v1.12.0
func (x Execution_StateError_Type) Number() protoreflect.EnumNumber
func (Execution_StateError_Type) String ¶ added in v1.12.0
func (x Execution_StateError_Type) String() string
func (Execution_StateError_Type) Type ¶ added in v1.12.0
func (Execution_StateError_Type) Type() protoreflect.EnumType
type Execution_Status ¶ added in v1.12.0
type Execution_Status struct { // A list of currently executing or last executed step names for the // workflow execution currently running. If the workflow has succeeded or // failed, this is the last attempted or executed step. Presently, if the // current step is inside a subworkflow, the list only includes that step. // In the future, the list will contain items for each step in the call // stack, starting with the outermost step in the `main` subworkflow, and // ending with the most deeply nested step. CurrentSteps []*Execution_Status_Step `protobuf:"bytes,1,rep,name=current_steps,json=currentSteps,proto3" json:"current_steps,omitempty"` // contains filtered or unexported fields }
Represents the current status of this execution.
func (*Execution_Status) Descriptor
deprecated
added in
v1.12.0
func (*Execution_Status) Descriptor() ([]byte, []int)
Deprecated: Use Execution_Status.ProtoReflect.Descriptor instead.
func (*Execution_Status) GetCurrentSteps ¶ added in v1.12.0
func (x *Execution_Status) GetCurrentSteps() []*Execution_Status_Step
func (*Execution_Status) ProtoMessage ¶ added in v1.12.0
func (*Execution_Status) ProtoMessage()
func (*Execution_Status) ProtoReflect ¶ added in v1.12.0
func (x *Execution_Status) ProtoReflect() protoreflect.Message
func (*Execution_Status) Reset ¶ added in v1.12.0
func (x *Execution_Status) Reset()
func (*Execution_Status) String ¶ added in v1.12.0
func (x *Execution_Status) String() string
type Execution_Status_Step ¶ added in v1.12.0
type Execution_Status_Step struct { // Name of a routine within the workflow. Routine string `protobuf:"bytes,1,opt,name=routine,proto3" json:"routine,omitempty"` // Name of a step within the routine. Step string `protobuf:"bytes,2,opt,name=step,proto3" json:"step,omitempty"` // contains filtered or unexported fields }
Represents a step of the workflow this execution is running.
func (*Execution_Status_Step) Descriptor
deprecated
added in
v1.12.0
func (*Execution_Status_Step) Descriptor() ([]byte, []int)
Deprecated: Use Execution_Status_Step.ProtoReflect.Descriptor instead.
func (*Execution_Status_Step) GetRoutine ¶ added in v1.12.0
func (x *Execution_Status_Step) GetRoutine() string
func (*Execution_Status_Step) GetStep ¶ added in v1.12.0
func (x *Execution_Status_Step) GetStep() string
func (*Execution_Status_Step) ProtoMessage ¶ added in v1.12.0
func (*Execution_Status_Step) ProtoMessage()
func (*Execution_Status_Step) ProtoReflect ¶ added in v1.12.0
func (x *Execution_Status_Step) ProtoReflect() protoreflect.Message
func (*Execution_Status_Step) Reset ¶ added in v1.12.0
func (x *Execution_Status_Step) Reset()
func (*Execution_Status_Step) String ¶ added in v1.12.0
func (x *Execution_Status_Step) String() string
type ExecutionsClient ¶
type ExecutionsClient interface { // Returns a list of executions which belong to the workflow with // the given name. The method returns executions of all workflow // revisions. Returned executions are ordered by their start time (newest // first). ListExecutions(ctx context.Context, in *ListExecutionsRequest, opts ...grpc.CallOption) (*ListExecutionsResponse, error) // Creates a new execution using the latest revision of the given workflow. CreateExecution(ctx context.Context, in *CreateExecutionRequest, opts ...grpc.CallOption) (*Execution, error) // Returns an execution of the given name. GetExecution(ctx context.Context, in *GetExecutionRequest, opts ...grpc.CallOption) (*Execution, error) // Cancels an execution of the given name. CancelExecution(ctx context.Context, in *CancelExecutionRequest, opts ...grpc.CallOption) (*Execution, error) }
ExecutionsClient is the client API for Executions service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewExecutionsClient ¶
func NewExecutionsClient(cc grpc.ClientConnInterface) ExecutionsClient
type ExecutionsServer ¶
type ExecutionsServer interface { // Returns a list of executions which belong to the workflow with // the given name. The method returns executions of all workflow // revisions. Returned executions are ordered by their start time (newest // first). ListExecutions(context.Context, *ListExecutionsRequest) (*ListExecutionsResponse, error) // Creates a new execution using the latest revision of the given workflow. CreateExecution(context.Context, *CreateExecutionRequest) (*Execution, error) // Returns an execution of the given name. GetExecution(context.Context, *GetExecutionRequest) (*Execution, error) // Cancels an execution of the given name. CancelExecution(context.Context, *CancelExecutionRequest) (*Execution, error) }
ExecutionsServer is the server API for Executions service.
type GetExecutionRequest ¶
type GetExecutionRequest struct { // Required. Name of the execution to be retrieved. // Format: // projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional. A view defining which fields should be filled in the returned // execution. The API will default to the FULL view. View ExecutionView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.workflows.executions.v1.ExecutionView" json:"view,omitempty"` // contains filtered or unexported fields }
Request for the [GetExecution][google.cloud.workflows.executions.v1.Executions.GetExecution] method.
func (*GetExecutionRequest) Descriptor
deprecated
func (*GetExecutionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetExecutionRequest.ProtoReflect.Descriptor instead.
func (*GetExecutionRequest) GetName ¶
func (x *GetExecutionRequest) GetName() string
func (*GetExecutionRequest) GetView ¶
func (x *GetExecutionRequest) GetView() ExecutionView
func (*GetExecutionRequest) ProtoMessage ¶
func (*GetExecutionRequest) ProtoMessage()
func (*GetExecutionRequest) ProtoReflect ¶
func (x *GetExecutionRequest) ProtoReflect() protoreflect.Message
func (*GetExecutionRequest) Reset ¶
func (x *GetExecutionRequest) Reset()
func (*GetExecutionRequest) String ¶
func (x *GetExecutionRequest) String() string
type ListExecutionsRequest ¶
type ListExecutionsRequest struct { // Required. Name of the workflow for which the executions should be listed. // Format: projects/{project}/locations/{location}/workflows/{workflow} Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // Maximum number of executions to return per call. // Max supported value depends on the selected Execution view: it's 1000 for // BASIC and 100 for FULL. The default value used if the field is not // specified is 100, regardless of the selected view. Values greater than // the max value will be coerced down to it. PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // A page token, received from a previous `ListExecutions` call. // Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to `ListExecutions` must // match the call that provided the page token. // // Note that pagination is applied to dynamic data. The list of executions // returned can change between page requests. PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // Optional. A view defining which fields should be filled in the returned // executions. The API will default to the BASIC view. View ExecutionView `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.workflows.executions.v1.ExecutionView" json:"view,omitempty"` // Optional. Filters applied to the [Executions.ListExecutions] results. // The following fields are supported for filtering: // executionID, state, startTime, endTime, duration, workflowRevisionID, // stepName, and label. Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"` // Optional. The ordering applied to the [Executions.ListExecutions] results. // By default the ordering is based on descending start time. // The following fields are supported for order by: // executionID, startTime, endTime, duration, state, and workflowRevisionID. OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"` // contains filtered or unexported fields }
Request for the [ListExecutions][] method.
func (*ListExecutionsRequest) Descriptor
deprecated
func (*ListExecutionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListExecutionsRequest.ProtoReflect.Descriptor instead.
func (*ListExecutionsRequest) GetFilter ¶ added in v1.12.0
func (x *ListExecutionsRequest) GetFilter() string
func (*ListExecutionsRequest) GetOrderBy ¶ added in v1.12.0
func (x *ListExecutionsRequest) GetOrderBy() string
func (*ListExecutionsRequest) GetPageSize ¶
func (x *ListExecutionsRequest) GetPageSize() int32
func (*ListExecutionsRequest) GetPageToken ¶
func (x *ListExecutionsRequest) GetPageToken() string
func (*ListExecutionsRequest) GetParent ¶
func (x *ListExecutionsRequest) GetParent() string
func (*ListExecutionsRequest) GetView ¶
func (x *ListExecutionsRequest) GetView() ExecutionView
func (*ListExecutionsRequest) ProtoMessage ¶
func (*ListExecutionsRequest) ProtoMessage()
func (*ListExecutionsRequest) ProtoReflect ¶
func (x *ListExecutionsRequest) ProtoReflect() protoreflect.Message
func (*ListExecutionsRequest) Reset ¶
func (x *ListExecutionsRequest) Reset()
func (*ListExecutionsRequest) String ¶
func (x *ListExecutionsRequest) String() string
type ListExecutionsResponse ¶
type ListExecutionsResponse struct { // The executions which match the request. Executions []*Execution `protobuf:"bytes,1,rep,name=executions,proto3" json:"executions,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 [ListExecutions][google.cloud.workflows.executions.v1.Executions.ListExecutions] method.
func (*ListExecutionsResponse) Descriptor
deprecated
func (*ListExecutionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListExecutionsResponse.ProtoReflect.Descriptor instead.
func (*ListExecutionsResponse) GetExecutions ¶
func (x *ListExecutionsResponse) GetExecutions() []*Execution
func (*ListExecutionsResponse) GetNextPageToken ¶
func (x *ListExecutionsResponse) GetNextPageToken() string
func (*ListExecutionsResponse) ProtoMessage ¶
func (*ListExecutionsResponse) ProtoMessage()
func (*ListExecutionsResponse) ProtoReflect ¶
func (x *ListExecutionsResponse) ProtoReflect() protoreflect.Message
func (*ListExecutionsResponse) Reset ¶
func (x *ListExecutionsResponse) Reset()
func (*ListExecutionsResponse) String ¶
func (x *ListExecutionsResponse) String() string
type UnimplementedExecutionsServer ¶
type UnimplementedExecutionsServer struct { }
UnimplementedExecutionsServer can be embedded to have forward compatible implementations.
func (*UnimplementedExecutionsServer) CancelExecution ¶
func (*UnimplementedExecutionsServer) CancelExecution(context.Context, *CancelExecutionRequest) (*Execution, error)
func (*UnimplementedExecutionsServer) CreateExecution ¶
func (*UnimplementedExecutionsServer) CreateExecution(context.Context, *CreateExecutionRequest) (*Execution, error)
func (*UnimplementedExecutionsServer) GetExecution ¶
func (*UnimplementedExecutionsServer) GetExecution(context.Context, *GetExecutionRequest) (*Execution, error)
func (*UnimplementedExecutionsServer) ListExecutions ¶
func (*UnimplementedExecutionsServer) ListExecutions(context.Context, *ListExecutionsRequest) (*ListExecutionsResponse, error)