Documentation ¶
Overview ¶
Package automation is a generated protocol buffer package.
It is generated from these files:
automation.proto
It has these top-level messages:
ClusterOperation TaskContainer Task EnqueueClusterOperationRequest EnqueueClusterOperationResponse GetClusterOperationStateRequest GetClusterOperationStateResponse GetClusterOperationDetailsRequest GetClusterOperationDetailsResponse
Index ¶
- Variables
- type ClusterOperation
- type ClusterOperationState
- type EnqueueClusterOperationRequest
- func (*EnqueueClusterOperationRequest) Descriptor() ([]byte, []int)
- func (m *EnqueueClusterOperationRequest) GetParameters() map[string]string
- func (*EnqueueClusterOperationRequest) ProtoMessage()
- func (m *EnqueueClusterOperationRequest) Reset()
- func (m *EnqueueClusterOperationRequest) String() string
- type EnqueueClusterOperationResponse
- type GetClusterOperationDetailsRequest
- type GetClusterOperationDetailsResponse
- func (*GetClusterOperationDetailsResponse) Descriptor() ([]byte, []int)
- func (m *GetClusterOperationDetailsResponse) GetClusterOp() *ClusterOperation
- func (*GetClusterOperationDetailsResponse) ProtoMessage()
- func (m *GetClusterOperationDetailsResponse) Reset()
- func (m *GetClusterOperationDetailsResponse) String() string
- type GetClusterOperationStateRequest
- type GetClusterOperationStateResponse
- type Task
- type TaskContainer
- type TaskState
Constants ¶
This section is empty.
Variables ¶
View Source
var ClusterOperationState_name = map[int32]string{
0: "UNKNOWN_CLUSTER_OPERATION_STATE",
1: "CLUSTER_OPERATION_NOT_STARTED",
2: "CLUSTER_OPERATION_RUNNING",
3: "CLUSTER_OPERATION_DONE",
}
View Source
var ClusterOperationState_value = map[string]int32{
"UNKNOWN_CLUSTER_OPERATION_STATE": 0,
"CLUSTER_OPERATION_NOT_STARTED": 1,
"CLUSTER_OPERATION_RUNNING": 2,
"CLUSTER_OPERATION_DONE": 3,
}
View Source
var TaskState_name = map[int32]string{
0: "UNKNOWN_TASK_STATE",
1: "NOT_STARTED",
2: "RUNNING",
3: "DONE",
}
View Source
var TaskState_value = map[string]int32{
"UNKNOWN_TASK_STATE": 0,
"NOT_STARTED": 1,
"RUNNING": 2,
"DONE": 3,
}
Functions ¶
This section is empty.
Types ¶
type ClusterOperation ¶
type ClusterOperation struct { Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"` // TaskContainer are processed sequentially, one at a time. SerialTasks []*TaskContainer `protobuf:"bytes,2,rep,name=serial_tasks,json=serialTasks" json:"serial_tasks,omitempty"` // Cached value. This has to be re-evaluated e.g. after a checkpoint load because running tasks may have already finished. State ClusterOperationState `protobuf:"varint,3,opt,name=state,enum=automation.ClusterOperationState" json:"state,omitempty"` // Error of the first task which failed. Set after state advanced to CLUSTER_OPERATION_DONE. If empty, all tasks succeeded. Cached value, see state above. Error string `protobuf:"bytes,4,opt,name=error" json:"error,omitempty"` }
func (*ClusterOperation) Descriptor ¶
func (*ClusterOperation) Descriptor() ([]byte, []int)
func (*ClusterOperation) GetSerialTasks ¶
func (m *ClusterOperation) GetSerialTasks() []*TaskContainer
func (*ClusterOperation) ProtoMessage ¶
func (*ClusterOperation) ProtoMessage()
func (*ClusterOperation) Reset ¶
func (m *ClusterOperation) Reset()
func (*ClusterOperation) String ¶
func (m *ClusterOperation) String() string
type ClusterOperationState ¶
type ClusterOperationState int32
const ( ClusterOperationState_UNKNOWN_CLUSTER_OPERATION_STATE ClusterOperationState = 0 ClusterOperationState_CLUSTER_OPERATION_NOT_STARTED ClusterOperationState = 1 ClusterOperationState_CLUSTER_OPERATION_RUNNING ClusterOperationState = 2 ClusterOperationState_CLUSTER_OPERATION_DONE ClusterOperationState = 3 )
func (ClusterOperationState) EnumDescriptor ¶
func (ClusterOperationState) EnumDescriptor() ([]byte, []int)
func (ClusterOperationState) String ¶
func (x ClusterOperationState) String() string
type EnqueueClusterOperationRequest ¶
type EnqueueClusterOperationRequest struct { Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` Parameters map[string]string `` /* 140-byte string literal not displayed */ }
func (*EnqueueClusterOperationRequest) Descriptor ¶
func (*EnqueueClusterOperationRequest) Descriptor() ([]byte, []int)
func (*EnqueueClusterOperationRequest) GetParameters ¶
func (m *EnqueueClusterOperationRequest) GetParameters() map[string]string
func (*EnqueueClusterOperationRequest) ProtoMessage ¶
func (*EnqueueClusterOperationRequest) ProtoMessage()
func (*EnqueueClusterOperationRequest) Reset ¶
func (m *EnqueueClusterOperationRequest) Reset()
func (*EnqueueClusterOperationRequest) String ¶
func (m *EnqueueClusterOperationRequest) String() string
type EnqueueClusterOperationResponse ¶
type EnqueueClusterOperationResponse struct {
Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}
func (*EnqueueClusterOperationResponse) Descriptor ¶
func (*EnqueueClusterOperationResponse) Descriptor() ([]byte, []int)
func (*EnqueueClusterOperationResponse) ProtoMessage ¶
func (*EnqueueClusterOperationResponse) ProtoMessage()
func (*EnqueueClusterOperationResponse) Reset ¶
func (m *EnqueueClusterOperationResponse) Reset()
func (*EnqueueClusterOperationResponse) String ¶
func (m *EnqueueClusterOperationResponse) String() string
type GetClusterOperationDetailsRequest ¶
type GetClusterOperationDetailsRequest struct {
Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}
func (*GetClusterOperationDetailsRequest) Descriptor ¶
func (*GetClusterOperationDetailsRequest) Descriptor() ([]byte, []int)
func (*GetClusterOperationDetailsRequest) ProtoMessage ¶
func (*GetClusterOperationDetailsRequest) ProtoMessage()
func (*GetClusterOperationDetailsRequest) Reset ¶
func (m *GetClusterOperationDetailsRequest) Reset()
func (*GetClusterOperationDetailsRequest) String ¶
func (m *GetClusterOperationDetailsRequest) String() string
type GetClusterOperationDetailsResponse ¶
type GetClusterOperationDetailsResponse struct { // Full snapshot of the execution e.g. including output of each task. ClusterOp *ClusterOperation `protobuf:"bytes,2,opt,name=cluster_op,json=clusterOp" json:"cluster_op,omitempty"` }
func (*GetClusterOperationDetailsResponse) Descriptor ¶
func (*GetClusterOperationDetailsResponse) Descriptor() ([]byte, []int)
func (*GetClusterOperationDetailsResponse) GetClusterOp ¶
func (m *GetClusterOperationDetailsResponse) GetClusterOp() *ClusterOperation
func (*GetClusterOperationDetailsResponse) ProtoMessage ¶
func (*GetClusterOperationDetailsResponse) ProtoMessage()
func (*GetClusterOperationDetailsResponse) Reset ¶
func (m *GetClusterOperationDetailsResponse) Reset()
func (*GetClusterOperationDetailsResponse) String ¶
func (m *GetClusterOperationDetailsResponse) String() string
type GetClusterOperationStateRequest ¶
type GetClusterOperationStateRequest struct {
Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}
func (*GetClusterOperationStateRequest) Descriptor ¶
func (*GetClusterOperationStateRequest) Descriptor() ([]byte, []int)
func (*GetClusterOperationStateRequest) ProtoMessage ¶
func (*GetClusterOperationStateRequest) ProtoMessage()
func (*GetClusterOperationStateRequest) Reset ¶
func (m *GetClusterOperationStateRequest) Reset()
func (*GetClusterOperationStateRequest) String ¶
func (m *GetClusterOperationStateRequest) String() string
type GetClusterOperationStateResponse ¶
type GetClusterOperationStateResponse struct {
State ClusterOperationState `protobuf:"varint,1,opt,name=state,enum=automation.ClusterOperationState" json:"state,omitempty"`
}
func (*GetClusterOperationStateResponse) Descriptor ¶
func (*GetClusterOperationStateResponse) Descriptor() ([]byte, []int)
func (*GetClusterOperationStateResponse) ProtoMessage ¶
func (*GetClusterOperationStateResponse) ProtoMessage()
func (*GetClusterOperationStateResponse) Reset ¶
func (m *GetClusterOperationStateResponse) Reset()
func (*GetClusterOperationStateResponse) String ¶
func (m *GetClusterOperationStateResponse) String() string
type Task ¶
type Task struct { // Task specification. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` Parameters map[string]string `` /* 140-byte string literal not displayed */ // Runtime data. Id string `protobuf:"bytes,3,opt,name=id" json:"id,omitempty"` State TaskState `protobuf:"varint,4,opt,name=state,enum=automation.TaskState" json:"state,omitempty"` // Set after state advanced to DONE. Output string `protobuf:"bytes,5,opt,name=output" json:"output,omitempty"` // Set after state advanced to DONE. If empty, the task did succeed. Error string `protobuf:"bytes,6,opt,name=error" json:"error,omitempty"` }
Task represents a specific task which should be automatically executed.
func (*Task) Descriptor ¶
func (*Task) GetParameters ¶
func (*Task) ProtoMessage ¶
func (*Task) ProtoMessage()
type TaskContainer ¶
type TaskContainer struct { ParallelTasks []*Task `protobuf:"bytes,1,rep,name=parallel_tasks,json=parallelTasks" json:"parallel_tasks,omitempty"` Concurrency int32 `protobuf:"varint,2,opt,name=concurrency" json:"concurrency,omitempty"` }
TaskContainer holds one or more task which may be executed in parallel. "concurrency", if > 0, limits the amount of concurrently executed tasks.
func (*TaskContainer) Descriptor ¶
func (*TaskContainer) Descriptor() ([]byte, []int)
func (*TaskContainer) GetParallelTasks ¶
func (m *TaskContainer) GetParallelTasks() []*Task
func (*TaskContainer) ProtoMessage ¶
func (*TaskContainer) ProtoMessage()
func (*TaskContainer) Reset ¶
func (m *TaskContainer) Reset()
func (*TaskContainer) String ¶
func (m *TaskContainer) String() string
Click to show internal directories.
Click to hide internal directories.