Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterExecutionsServer(s grpc.ServiceRegistrar, 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) GetEndTime() *timestamppb.Timestamp
- func (x *Execution) GetError() *Execution_Error
- 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) 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_Error
- func (*Execution_Error) Descriptor() ([]byte, []int)deprecated
- func (x *Execution_Error) GetContext() string
- func (x *Execution_Error) GetPayload() string
- func (*Execution_Error) ProtoMessage()
- func (x *Execution_Error) ProtoReflect() protoreflect.Message
- func (x *Execution_Error) Reset()
- func (x *Execution_Error) 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 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) 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)
- type UnsafeExecutionsServer
Constants ¶
const ( Executions_ListExecutions_FullMethodName = "/google.cloud.workflows.executions.v1beta.Executions/ListExecutions" Executions_CreateExecution_FullMethodName = "/google.cloud.workflows.executions.v1beta.Executions/CreateExecution" Executions_GetExecution_FullMethodName = "/google.cloud.workflows.executions.v1beta.Executions/GetExecution" Executions_CancelExecution_FullMethodName = "/google.cloud.workflows.executions.v1beta.Executions/CancelExecution" )
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", } Execution_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "ACTIVE": 1, "SUCCEEDED": 2, "FAILED": 3, "CANCELLED": 4, } )
Enum value maps for Execution_State.
var Executions_ServiceDesc = grpc.ServiceDesc{ ServiceName: "google.cloud.workflows.executions.v1beta.Executions", HandlerType: (*ExecutionsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListExecutions", Handler: _Executions_ListExecutions_Handler, }, { MethodName: "CreateExecution", Handler: _Executions_CreateExecution_Handler, }, { MethodName: "GetExecution", Handler: _Executions_GetExecution_Handler, }, { MethodName: "CancelExecution", Handler: _Executions_CancelExecution_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "google/cloud/workflows/executions/v1beta/executions.proto", }
Executions_ServiceDesc is the grpc.ServiceDesc for Executions service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_google_cloud_workflows_executions_v1beta_executions_proto protoreflect.FileDescriptor
Functions ¶
func RegisterExecutionsServer ¶
func RegisterExecutionsServer(s grpc.ServiceRegistrar, 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.v1beta.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.v1beta.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. Current state of the execution.
State Execution_State `` /* 126-byte string literal not displayed */
// Input parameters of the execution represented as a JSON string.
// The size limit is 32KB.
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"`
// contains filtered or unexported fields
}
A running instance of a [Workflow][google.cloud.workflows.v1beta.Workflow].
func (*Execution) Descriptor
deprecated
func (*Execution) GetArgument ¶
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) 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. // 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.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_Error ¶
type Execution_Error struct {
// Error payload returned by the execution, represented as a JSON string.
Payload string `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
// Human readable error context, helpful for debugging purposes.
Context string `protobuf:"bytes,2,opt,name=context,proto3" json:"context,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) 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_State ¶
type Execution_State int32
Describes the current state of the execution. More states may 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 )
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 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://pkg.go.dev/google.golang.org/grpc/?tab=doc#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. All implementations should embed UnimplementedExecutionsServer for forward compatibility
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.v1beta.ExecutionView" json:"view,omitempty"`
// contains filtered or unexported fields
}
Request for the [GetExecution][google.cloud.workflows.executions.v1beta.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 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.v1beta.ExecutionView" json:"view,omitempty"`
// contains filtered or unexported fields
}
Request for the [ListExecutions][google.cloud.workflows.executions.v1beta.Executions.ListExecutions] method.
func (*ListExecutionsRequest) Descriptor
deprecated
func (*ListExecutionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListExecutionsRequest.ProtoReflect.Descriptor instead.
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.v1beta.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 should 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)
type UnsafeExecutionsServer ¶ added in v1.14.3
type UnsafeExecutionsServer interface {
// contains filtered or unexported methods
}
UnsafeExecutionsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExecutionsServer will result in compilation errors.