Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)
- type CreateTaskRequst
- func (*CreateTaskRequst) Descriptor() ([]byte, []int)deprecated
- func (x *CreateTaskRequst) GetDryRun() bool
- func (x *CreateTaskRequst) GetParams() map[string]string
- func (x *CreateTaskRequst) GetRegion() string
- func (x *CreateTaskRequst) GetResourceType() resource.Type
- func (x *CreateTaskRequst) GetSecretId() string
- func (x *CreateTaskRequst) GetTimeout() int64
- func (x *CreateTaskRequst) GetType() Type
- func (*CreateTaskRequst) ProtoMessage()
- func (x *CreateTaskRequst) ProtoReflect() protoreflect.Message
- func (x *CreateTaskRequst) Reset()
- func (x *CreateTaskRequst) String() string
- func (req *CreateTaskRequst) Validate() error
- type DescribeTaskRequest
- func (*DescribeTaskRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DescribeTaskRequest) GetId() string
- func (*DescribeTaskRequest) ProtoMessage()
- func (x *DescribeTaskRequest) ProtoReflect() protoreflect.Message
- func (x *DescribeTaskRequest) Reset()
- func (x *DescribeTaskRequest) String() string
- type QueryTaskRequest
- func (*QueryTaskRequest) Descriptor() ([]byte, []int)deprecated
- func (x *QueryTaskRequest) GetKeywords() string
- func (x *QueryTaskRequest) GetPage() *request.PageRequest
- func (x *QueryTaskRequest) GetResourceType() resource.Type
- func (*QueryTaskRequest) ProtoMessage()
- func (x *QueryTaskRequest) ProtoReflect() protoreflect.Message
- func (x *QueryTaskRequest) Reset()
- func (x *QueryTaskRequest) String() string
- type ServiceClient
- type ServiceServer
- type Stage
- func (Stage) Descriptor() protoreflect.EnumDescriptor
- func (x Stage) Enum() *Stage
- func (Stage) EnumDescriptor() ([]byte, []int)deprecated
- func (t Stage) Equal(target Stage) bool
- func (t Stage) IsIn(targets ...Stage) bool
- func (t Stage) MarshalJSON() ([]byte, error)
- func (x Stage) Number() protoreflect.EnumNumber
- func (x Stage) String() string
- func (Stage) Type() protoreflect.EnumType
- func (t *Stage) UnmarshalJSON(b []byte) error
- type Status
- func (*Status) Descriptor() ([]byte, []int)deprecated
- func (x *Status) GetEndAt() int64
- func (x *Status) GetMessage() string
- func (x *Status) GetStage() Stage
- func (x *Status) GetStartAt() int64
- func (x *Status) GetTotalFailed() int64
- func (x *Status) GetTotalSucceed() int64
- func (*Status) ProtoMessage()
- func (x *Status) ProtoReflect() protoreflect.Message
- func (x *Status) Reset()
- func (x *Status) String() string
- type Task
- func (*Task) Descriptor() ([]byte, []int)deprecated
- func (s *Task) Failed(message string)
- func (x *Task) GetData() *CreateTaskRequst
- func (x *Task) GetId() string
- func (x *Task) GetSecretDescription() string
- func (x *Task) GetStatus() *Status
- func (*Task) ProtoMessage()
- func (x *Task) ProtoReflect() protoreflect.Message
- func (x *Task) Reset()
- func (s *Task) Run()
- func (x *Task) String() string
- func (s *Task) Success()
- type TaskSet
- type Type
- func (Type) Descriptor() protoreflect.EnumDescriptor
- func (x Type) Enum() *Type
- func (Type) EnumDescriptor() ([]byte, []int)deprecated
- func (t Type) Equal(target Type) bool
- func (t Type) IsIn(targets ...Type) bool
- func (t Type) MarshalJSON() ([]byte, error)
- func (x Type) Number() protoreflect.EnumNumber
- func (x Type) String() string
- func (Type) Type() protoreflect.EnumType
- func (t *Type) UnmarshalJSON(b []byte) error
- type UnimplementedServiceServer
- type UnsafeServiceServer
Constants ¶
const (
AppName = "task"
)
Variables ¶
var ( Type_name = map[int32]string{ 0: "RESOURCE_SYNC", 1: "RESOURCE_RELEASE", } Type_value = map[string]int32{ "RESOURCE_SYNC": 0, "RESOURCE_RELEASE": 1, } )
Enum value maps for Type.
var ( Stage_name = map[int32]string{ 0: "PENDDING", 1: "RUNNING", 2: "SUCCESS", 3: "FAILED", 4: "WARNING", } Stage_value = map[string]int32{ "PENDDING": 0, "RUNNING": 1, "SUCCESS": 2, "FAILED": 3, "WARNING": 4, } )
Enum value maps for Stage.
var File_apps_task_pb_task_proto protoreflect.FileDescriptor
var Service_ServiceDesc = grpc.ServiceDesc{ ServiceName: "course.cmdb.task.Service", HandlerType: (*ServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateTask", Handler: _Service_CreateTask_Handler, }, { MethodName: "QueryBook", Handler: _Service_QueryBook_Handler, }, { MethodName: "DescribeBook", Handler: _Service_DescribeBook_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "apps/task/pb/task.proto", }
Service_ServiceDesc is the grpc.ServiceDesc for Service service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterServiceServer ¶
func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)
Types ¶
type CreateTaskRequst ¶
type CreateTaskRequst struct { // 任务类型 // @gotags: json:"type" Type Type `protobuf:"varint,1,opt,name=type,proto3,enum=course.cmdb.task.Type" json:"type"` // 测试运行 // @gotags: json:"dry_run" DryRun bool `protobuf:"varint,2,opt,name=dry_run,json=dryRun,proto3" json:"dry_run"` // 任务使用的云商凭证Id // @gotags: json:"secret_id" validate:"required,lte=100" SecretId string `protobuf:"bytes,3,opt,name=secret_id,json=secretId,proto3" json:"secret_id" validate:"required,lte=100"` // 任务操作的资源类型 // @gotags: json:"resource_type" ResourceType resource.Type `protobuf:"varint,4,opt,name=resource_type,json=resourceType,proto3,enum=course.cmdb.resource.Type" json:"resource_type"` // 通知资源的Region // @gotags: json:"region" Region string `protobuf:"bytes,5,opt,name=region,proto3" json:"region"` // 额外的一些参数 // @gotags: json:"params" Params map[string]string `` /* 143-byte string literal not displayed */ // 任务执行的超时时间, 单位时秒 // @gotags: json:"timeout" Timeout int64 `protobuf:"varint,7,opt,name=timeout,proto3" json:"timeout"` // contains filtered or unexported fields }
func NewCreateTaskRequst ¶
func NewCreateTaskRequst() *CreateTaskRequst
func (*CreateTaskRequst) Descriptor
deprecated
func (*CreateTaskRequst) Descriptor() ([]byte, []int)
Deprecated: Use CreateTaskRequst.ProtoReflect.Descriptor instead.
func (*CreateTaskRequst) GetDryRun ¶
func (x *CreateTaskRequst) GetDryRun() bool
func (*CreateTaskRequst) GetParams ¶
func (x *CreateTaskRequst) GetParams() map[string]string
func (*CreateTaskRequst) GetRegion ¶
func (x *CreateTaskRequst) GetRegion() string
func (*CreateTaskRequst) GetResourceType ¶
func (x *CreateTaskRequst) GetResourceType() resource.Type
func (*CreateTaskRequst) GetSecretId ¶
func (x *CreateTaskRequst) GetSecretId() string
func (*CreateTaskRequst) GetTimeout ¶
func (x *CreateTaskRequst) GetTimeout() int64
func (*CreateTaskRequst) GetType ¶
func (x *CreateTaskRequst) GetType() Type
func (*CreateTaskRequst) ProtoMessage ¶
func (*CreateTaskRequst) ProtoMessage()
func (*CreateTaskRequst) ProtoReflect ¶
func (x *CreateTaskRequst) ProtoReflect() protoreflect.Message
func (*CreateTaskRequst) Reset ¶
func (x *CreateTaskRequst) Reset()
func (*CreateTaskRequst) String ¶
func (x *CreateTaskRequst) String() string
func (*CreateTaskRequst) Validate ¶
func (req *CreateTaskRequst) Validate() error
type DescribeTaskRequest ¶
type DescribeTaskRequest struct { // Task id // @gotags: json:"id" validate:"required" Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id" validate:"required"` // contains filtered or unexported fields }
func (*DescribeTaskRequest) Descriptor
deprecated
func (*DescribeTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use DescribeTaskRequest.ProtoReflect.Descriptor instead.
func (*DescribeTaskRequest) GetId ¶
func (x *DescribeTaskRequest) GetId() string
func (*DescribeTaskRequest) ProtoMessage ¶
func (*DescribeTaskRequest) ProtoMessage()
func (*DescribeTaskRequest) ProtoReflect ¶
func (x *DescribeTaskRequest) ProtoReflect() protoreflect.Message
func (*DescribeTaskRequest) Reset ¶
func (x *DescribeTaskRequest) Reset()
func (*DescribeTaskRequest) String ¶
func (x *DescribeTaskRequest) String() string
type QueryTaskRequest ¶
type QueryTaskRequest struct { // 分页参数 // @gotags: json:"page" Page *request.PageRequest `protobuf:"bytes,1,opt,name=page,proto3" json:"page"` // 更加资源类型来过滤任务 // @gotags: json:"resource_type" ResourceType resource.Type `protobuf:"varint,3,opt,name=resource_type,json=resourceType,proto3,enum=course.cmdb.resource.Type" json:"resource_type"` // @gotags: json:"keywords" Keywords string `protobuf:"bytes,4,opt,name=keywords,proto3" json:"keywords"` // contains filtered or unexported fields }
func (*QueryTaskRequest) Descriptor
deprecated
func (*QueryTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryTaskRequest.ProtoReflect.Descriptor instead.
func (*QueryTaskRequest) GetKeywords ¶
func (x *QueryTaskRequest) GetKeywords() string
func (*QueryTaskRequest) GetPage ¶
func (x *QueryTaskRequest) GetPage() *request.PageRequest
func (*QueryTaskRequest) GetResourceType ¶
func (x *QueryTaskRequest) GetResourceType() resource.Type
func (*QueryTaskRequest) ProtoMessage ¶
func (*QueryTaskRequest) ProtoMessage()
func (*QueryTaskRequest) ProtoReflect ¶
func (x *QueryTaskRequest) ProtoReflect() protoreflect.Message
func (*QueryTaskRequest) Reset ¶
func (x *QueryTaskRequest) Reset()
func (*QueryTaskRequest) String ¶
func (x *QueryTaskRequest) String() string
type ServiceClient ¶
type ServiceClient interface { CreateTask(ctx context.Context, in *CreateTaskRequst, opts ...grpc.CallOption) (*Task, error) QueryBook(ctx context.Context, in *QueryTaskRequest, opts ...grpc.CallOption) (*TaskSet, error) DescribeBook(ctx context.Context, in *DescribeTaskRequest, opts ...grpc.CallOption) (*Task, error) }
ServiceClient is the client API for Service 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 NewServiceClient ¶
func NewServiceClient(cc grpc.ClientConnInterface) ServiceClient
type ServiceServer ¶
type ServiceServer interface { CreateTask(context.Context, *CreateTaskRequst) (*Task, error) QueryBook(context.Context, *QueryTaskRequest) (*TaskSet, error) DescribeBook(context.Context, *DescribeTaskRequest) (*Task, error) // contains filtered or unexported methods }
ServiceServer is the server API for Service service. All implementations must embed UnimplementedServiceServer for forward compatibility
type Stage ¶
type Stage int32
任务运行的状态
func ParseStageFromString ¶
ParseStageFromString Parse Stage from string
func (Stage) Descriptor ¶
func (Stage) Descriptor() protoreflect.EnumDescriptor
func (Stage) EnumDescriptor
deprecated
func (Stage) Number ¶
func (x Stage) Number() protoreflect.EnumNumber
func (Stage) Type ¶
func (Stage) Type() protoreflect.EnumType
type Status ¶
type Status struct { // 任务状态 // @gotags: json:"stage" Stage Stage `protobuf:"varint,1,opt,name=stage,proto3,enum=course.cmdb.task.Stage" json:"stage"` // 失败时的异常信息 // @gotags: json:"message" Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message"` // 开始同步的时间 // @gotags: json:"start_at" StartAt int64 `protobuf:"varint,3,opt,name=start_at,json=startAt,proto3" json:"start_at"` // 同步结束时间 // @gotags: json:"end_at" EndAt int64 `protobuf:"varint,4,opt,name=end_at,json=endAt,proto3" json:"end_at"` // 成功的条数 // @gotags: json:"total_succeed" TotalSucceed int64 `protobuf:"varint,5,opt,name=total_succeed,json=totalSucceed,proto3" json:"total_succeed"` // 失败的条数 // @gotags: json:"total_failed" TotalFailed int64 `protobuf:"varint,6,opt,name=total_failed,json=totalFailed,proto3" json:"total_failed"` // contains filtered or unexported fields }
func (*Status) Descriptor
deprecated
func (*Status) GetMessage ¶
func (*Status) GetStartAt ¶
func (*Status) GetTotalFailed ¶
func (*Status) GetTotalSucceed ¶
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) ProtoReflect ¶
func (x *Status) ProtoReflect() protoreflect.Message
type Task ¶
type Task struct { // 任务id // @gotags: json:"id" Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id"` // secret // @gotags: json:"secret_description" SecretDescription string `protobuf:"bytes,2,opt,name=secret_description,json=secretDescription,proto3" json:"secret_description"` // 任务描述 // @gotags: json:"data" Data *CreateTaskRequst `protobuf:"bytes,3,opt,name=data,proto3" json:"data"` // 任务状态 // @gotags: json:"status" Status *Status `protobuf:"bytes,4,opt,name=status,proto3" json:"status"` // contains filtered or unexported fields }
Task 同个区域的同一种资源一次只能有1个task run
func CreateTask ¶
func CreateTask(req *CreateTaskRequst) (*Task, error)
func NewDefaultTask ¶
func NewDefaultTask() *Task
func (*Task) Descriptor
deprecated
func (*Task) GetData ¶
func (x *Task) GetData() *CreateTaskRequst
func (*Task) GetSecretDescription ¶
func (*Task) ProtoMessage ¶
func (*Task) ProtoMessage()
func (*Task) ProtoReflect ¶
func (x *Task) ProtoReflect() protoreflect.Message
type TaskSet ¶
type TaskSet struct { // @gotags: json:"total" Total int64 `protobuf:"varint,1,opt,name=total,proto3" json:"total"` // @gotags: json:"items" Items []*Task `protobuf:"bytes,2,rep,name=items,proto3" json:"items"` // contains filtered or unexported fields }
func (*TaskSet) Descriptor
deprecated
func (*TaskSet) ProtoMessage ¶
func (*TaskSet) ProtoMessage()
func (*TaskSet) ProtoReflect ¶
func (x *TaskSet) ProtoReflect() protoreflect.Message
type Type ¶
type Type int32
任务类型
func ParseTypeFromString ¶
ParseTypeFromString Parse Type from string
func (Type) Descriptor ¶
func (Type) Descriptor() protoreflect.EnumDescriptor
func (Type) EnumDescriptor
deprecated
func (Type) Number ¶
func (x Type) Number() protoreflect.EnumNumber
func (Type) Type ¶
func (Type) Type() protoreflect.EnumType
type UnimplementedServiceServer ¶
type UnimplementedServiceServer struct { }
UnimplementedServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedServiceServer) CreateTask ¶
func (UnimplementedServiceServer) CreateTask(context.Context, *CreateTaskRequst) (*Task, error)
func (UnimplementedServiceServer) DescribeBook ¶
func (UnimplementedServiceServer) DescribeBook(context.Context, *DescribeTaskRequest) (*Task, error)
func (UnimplementedServiceServer) QueryBook ¶
func (UnimplementedServiceServer) QueryBook(context.Context, *QueryTaskRequest) (*TaskSet, error)
type UnsafeServiceServer ¶
type UnsafeServiceServer interface {
// contains filtered or unexported methods
}
UnsafeServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServiceServer will result in compilation errors.