Variables
ExecutionView_name, ExecutionView_value
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.
Execution_State_name, Execution_State_value
var (
Execution_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "SUCCEEDED",
3: "FAILED",
4: "CANCELLED",
}
Execution_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"SUCCEEDED": 2,
"FAILED": 3,
"CANCELLED": 4,
}
)Enum value maps for Execution_State.
Execution_CallLogLevel_name, Execution_CallLogLevel_value
var (
Execution_CallLogLevel_name = map[int32]string{
0: "CALL_LOG_LEVEL_UNSPECIFIED",
1: "LOG_ALL_CALLS",
2: "LOG_ERRORS_ONLY",
}
Execution_CallLogLevel_value = map[string]int32{
"CALL_LOG_LEVEL_UNSPECIFIED": 0,
"LOG_ALL_CALLS": 1,
"LOG_ERRORS_ONLY": 2,
}
)Enum value maps for Execution_CallLogLevel.
File_google_cloud_workflows_executions_v1_executions_proto
var File_google_cloud_workflows_executions_v1_executions_proto protoreflect.FileDescriptorFunctions
func RegisterExecutionsServer
func RegisterExecutionsServer(s *grpc.Server, srv ExecutionsServer)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
func (*CancelExecutionRequest) Descriptor() ([]byte, []int)Deprecated: Use CancelExecutionRequest.ProtoReflect.Descriptor instead.
func (*CancelExecutionRequest) GetName
func (x *CancelExecutionRequest) GetName() stringfunc (*CancelExecutionRequest) ProtoMessage
func (*CancelExecutionRequest) ProtoMessage()func (*CancelExecutionRequest) ProtoReflect
func (x *CancelExecutionRequest) ProtoReflect() protoreflect.Messagefunc (*CancelExecutionRequest) Reset
func (x *CancelExecutionRequest) Reset()func (*CancelExecutionRequest) String
func (x *CancelExecutionRequest) String() stringCreateExecutionRequest
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
func (*CreateExecutionRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateExecutionRequest.ProtoReflect.Descriptor instead.
func (*CreateExecutionRequest) GetExecution
func (x *CreateExecutionRequest) GetExecution() *Executionfunc (*CreateExecutionRequest) GetParent
func (x *CreateExecutionRequest) GetParent() stringfunc (*CreateExecutionRequest) ProtoMessage
func (*CreateExecutionRequest) ProtoMessage()func (*CreateExecutionRequest) ProtoReflect
func (x *CreateExecutionRequest) ProtoReflect() protoreflect.Messagefunc (*CreateExecutionRequest) Reset
func (x *CreateExecutionRequest) Reset()func (*CreateExecutionRequest) String
func (x *CreateExecutionRequest) String() stringExecution
type Execution struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
StartTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
EndTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
State Execution_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.workflows.executions.v1.Execution_State" json:"state,omitempty"`
Argument string `protobuf:"bytes,5,opt,name=argument,proto3" json:"argument,omitempty"`
Result string `protobuf:"bytes,6,opt,name=result,proto3" json:"result,omitempty"`
Error *Execution_Error `protobuf:"bytes,7,opt,name=error,proto3" json:"error,omitempty"`
WorkflowRevisionId string `protobuf:"bytes,8,opt,name=workflow_revision_id,json=workflowRevisionId,proto3" json:"workflow_revision_id,omitempty"`
CallLogLevel Execution_CallLogLevel "" /* 165 byte string literal not displayed */
}A running instance of a Workflow.
func (*Execution) Descriptor
Deprecated: Use Execution.ProtoReflect.Descriptor instead.
func (*Execution) GetArgument
func (*Execution) GetCallLogLevel
func (x *Execution) GetCallLogLevel() Execution_CallLogLevelfunc (*Execution) GetEndTime
func (*Execution) GetError
func (x *Execution) GetError() *Execution_Errorfunc (*Execution) GetName
func (*Execution) GetResult
func (*Execution) GetStartTime
func (*Execution) GetState
func (x *Execution) GetState() Execution_Statefunc (*Execution) GetWorkflowRevisionId
func (*Execution) ProtoMessage
func (*Execution) ProtoMessage()func (*Execution) ProtoReflect
func (x *Execution) ProtoReflect() protoreflect.Messagefunc (*Execution) Reset
func (x *Execution) Reset()func (*Execution) String
ExecutionView
type ExecutionView int32Defines possible views for execution resource.
ExecutionView_EXECUTION_VIEW_UNSPECIFIED, ExecutionView_BASIC, ExecutionView_FULL
const (
// The default / unset value.
ExecutionView_EXECUTION_VIEW_UNSPECIFIED ExecutionView = 0
// Includes only basic metadata about the execution.
// Following fields are returned: name, start_time, end_time, state
// and workflow_revision_id.
ExecutionView_BASIC ExecutionView = 1
// Includes all data.
ExecutionView_FULL ExecutionView = 2
)func (ExecutionView) Descriptor
func (ExecutionView) Descriptor() protoreflect.EnumDescriptorfunc (ExecutionView) Enum
func (x ExecutionView) Enum() *ExecutionViewfunc (ExecutionView) EnumDescriptor
func (ExecutionView) EnumDescriptor() ([]byte, []int)Deprecated: Use ExecutionView.Descriptor instead.
func (ExecutionView) Number
func (x ExecutionView) Number() protoreflect.EnumNumberfunc (ExecutionView) String
func (x ExecutionView) String() stringfunc (ExecutionView) Type
func (ExecutionView) Type() protoreflect.EnumTypeExecution_CallLogLevel
type Execution_CallLogLevel int32Describes the level of platform logging to apply to calls and call responses during workflow executions.
Execution_CALL_LOG_LEVEL_UNSPECIFIED, Execution_LOG_ALL_CALLS, Execution_LOG_ERRORS_ONLY
const (
// No call logging 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
)func (Execution_CallLogLevel) Descriptor
func (Execution_CallLogLevel) Descriptor() protoreflect.EnumDescriptorfunc (Execution_CallLogLevel) Enum
func (x Execution_CallLogLevel) Enum() *Execution_CallLogLevelfunc (Execution_CallLogLevel) EnumDescriptor
func (Execution_CallLogLevel) EnumDescriptor() ([]byte, []int)Deprecated: Use Execution_CallLogLevel.Descriptor instead.
func (Execution_CallLogLevel) Number
func (x Execution_CallLogLevel) Number() protoreflect.EnumNumberfunc (Execution_CallLogLevel) String
func (x Execution_CallLogLevel) String() stringfunc (Execution_CallLogLevel) Type
func (Execution_CallLogLevel) Type() protoreflect.EnumTypeExecution_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
func (*Execution_Error) Descriptor() ([]byte, []int)Deprecated: Use Execution_Error.ProtoReflect.Descriptor instead.
func (*Execution_Error) GetContext
func (x *Execution_Error) GetContext() stringfunc (*Execution_Error) GetPayload
func (x *Execution_Error) GetPayload() stringfunc (*Execution_Error) GetStackTrace
func (x *Execution_Error) GetStackTrace() *Execution_StackTracefunc (*Execution_Error) ProtoMessage
func (*Execution_Error) ProtoMessage()func (*Execution_Error) ProtoReflect
func (x *Execution_Error) ProtoReflect() protoreflect.Messagefunc (*Execution_Error) Reset
func (x *Execution_Error) Reset()func (*Execution_Error) String
func (x *Execution_Error) String() stringExecution_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
func (*Execution_StackTrace) Descriptor() ([]byte, []int)Deprecated: Use Execution_StackTrace.ProtoReflect.Descriptor instead.
func (*Execution_StackTrace) GetElements
func (x *Execution_StackTrace) GetElements() []*Execution_StackTraceElementfunc (*Execution_StackTrace) ProtoMessage
func (*Execution_StackTrace) ProtoMessage()func (*Execution_StackTrace) ProtoReflect
func (x *Execution_StackTrace) ProtoReflect() protoreflect.Messagefunc (*Execution_StackTrace) Reset
func (x *Execution_StackTrace) Reset()func (*Execution_StackTrace) String
func (x *Execution_StackTrace) String() stringExecution_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
func (*Execution_StackTraceElement) Descriptor() ([]byte, []int)Deprecated: Use Execution_StackTraceElement.ProtoReflect.Descriptor instead.
func (*Execution_StackTraceElement) GetPosition
func (x *Execution_StackTraceElement) GetPosition() *Execution_StackTraceElement_Positionfunc (*Execution_StackTraceElement) GetRoutine
func (x *Execution_StackTraceElement) GetRoutine() stringfunc (*Execution_StackTraceElement) GetStep
func (x *Execution_StackTraceElement) GetStep() stringfunc (*Execution_StackTraceElement) ProtoMessage
func (*Execution_StackTraceElement) ProtoMessage()func (*Execution_StackTraceElement) ProtoReflect
func (x *Execution_StackTraceElement) ProtoReflect() protoreflect.Messagefunc (*Execution_StackTraceElement) Reset
func (x *Execution_StackTraceElement) Reset()func (*Execution_StackTraceElement) String
func (x *Execution_StackTraceElement) String() stringExecution_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
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() int64func (*Execution_StackTraceElement_Position) GetLength
func (x *Execution_StackTraceElement_Position) GetLength() int64func (*Execution_StackTraceElement_Position) GetLine
func (x *Execution_StackTraceElement_Position) GetLine() int64func (*Execution_StackTraceElement_Position) ProtoMessage
func (*Execution_StackTraceElement_Position) ProtoMessage()func (*Execution_StackTraceElement_Position) ProtoReflect
func (x *Execution_StackTraceElement_Position) ProtoReflect() protoreflect.Messagefunc (*Execution_StackTraceElement_Position) Reset
func (x *Execution_StackTraceElement_Position) Reset()func (*Execution_StackTraceElement_Position) String
func (x *Execution_StackTraceElement_Position) String() stringExecution_State
type Execution_State int32Describes the current state of the execution. More states might be added in the future.
Execution_STATE_UNSPECIFIED, Execution_ACTIVE, Execution_SUCCEEDED, Execution_FAILED, Execution_CANCELLED
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
)func (Execution_State) Descriptor
func (Execution_State) Descriptor() protoreflect.EnumDescriptorfunc (Execution_State) Enum
func (x Execution_State) Enum() *Execution_Statefunc (Execution_State) EnumDescriptor
func (Execution_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Execution_State.Descriptor instead.
func (Execution_State) Number
func (x Execution_State) Number() protoreflect.EnumNumberfunc (Execution_State) String
func (x Execution_State) String() stringfunc (Execution_State) Type
func (Execution_State) Type() protoreflect.EnumTypeExecutionsClient
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) ExecutionsClientExecutionsServer
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.
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
func (*GetExecutionRequest) Descriptor() ([]byte, []int)Deprecated: Use GetExecutionRequest.ProtoReflect.Descriptor instead.
func (*GetExecutionRequest) GetName
func (x *GetExecutionRequest) GetName() stringfunc (*GetExecutionRequest) GetView
func (x *GetExecutionRequest) GetView() ExecutionViewfunc (*GetExecutionRequest) ProtoMessage
func (*GetExecutionRequest) ProtoMessage()func (*GetExecutionRequest) ProtoReflect
func (x *GetExecutionRequest) ProtoReflect() protoreflect.Messagefunc (*GetExecutionRequest) Reset
func (x *GetExecutionRequest) Reset()func (*GetExecutionRequest) String
func (x *GetExecutionRequest) String() stringListExecutionsRequest
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 10000 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.
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"`
// contains filtered or unexported fields
}Request for the [ListExecutions][] method.
func (*ListExecutionsRequest) Descriptor
func (*ListExecutionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListExecutionsRequest.ProtoReflect.Descriptor instead.
func (*ListExecutionsRequest) GetPageSize
func (x *ListExecutionsRequest) GetPageSize() int32func (*ListExecutionsRequest) GetPageToken
func (x *ListExecutionsRequest) GetPageToken() stringfunc (*ListExecutionsRequest) GetParent
func (x *ListExecutionsRequest) GetParent() stringfunc (*ListExecutionsRequest) GetView
func (x *ListExecutionsRequest) GetView() ExecutionViewfunc (*ListExecutionsRequest) ProtoMessage
func (*ListExecutionsRequest) ProtoMessage()func (*ListExecutionsRequest) ProtoReflect
func (x *ListExecutionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListExecutionsRequest) Reset
func (x *ListExecutionsRequest) Reset()func (*ListExecutionsRequest) String
func (x *ListExecutionsRequest) String() stringListExecutionsResponse
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
func (*ListExecutionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListExecutionsResponse.ProtoReflect.Descriptor instead.
func (*ListExecutionsResponse) GetExecutions
func (x *ListExecutionsResponse) GetExecutions() []*Executionfunc (*ListExecutionsResponse) GetNextPageToken
func (x *ListExecutionsResponse) GetNextPageToken() stringfunc (*ListExecutionsResponse) ProtoMessage
func (*ListExecutionsResponse) ProtoMessage()func (*ListExecutionsResponse) ProtoReflect
func (x *ListExecutionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListExecutionsResponse) Reset
func (x *ListExecutionsResponse) Reset()func (*ListExecutionsResponse) String
func (x *ListExecutionsResponse) String() stringUnimplementedExecutionsServer
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)