plugin

package
v0.0.0-...-ae3c806 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 1, 2024 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

View Source
const (
	Collector_Init_FullMethodName    = "/spaceone.api.inventory.plugin.Collector/init"
	Collector_Verify_FullMethodName  = "/spaceone.api.inventory.plugin.Collector/verify"
	Collector_Collect_FullMethodName = "/spaceone.api.inventory.plugin.Collector/collect"
)
View Source
const (
	Job_GetTasks_FullMethodName = "/spaceone.api.inventory.plugin.Job/get_tasks"
)

Variables

View Source
var (
	ResourceInfo_State_name = map[int32]string{
		0: "NONE",
		1: "CREATED",
		2: "PENDING",
		3: "INPROGRESS",
		4: "SUCCESS",
		5: "FAILURE",
		6: "TIMEOUT",
		7: "IDLE",
		8: "SKIP",
	}
	ResourceInfo_State_value = map[string]int32{
		"NONE":       0,
		"CREATED":    1,
		"PENDING":    2,
		"INPROGRESS": 3,
		"SUCCESS":    4,
		"FAILURE":    5,
		"TIMEOUT":    6,
		"IDLE":       7,
		"SKIP":       8,
	}
)

Enum value maps for ResourceInfo_State.

View Source
var Collector_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "spaceone.api.inventory.plugin.Collector",
	HandlerType: (*CollectorServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "init",
			Handler:    _Collector_Init_Handler,
		},
		{
			MethodName: "verify",
			Handler:    _Collector_Verify_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "collect",
			Handler:       _Collector_Collect_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "spaceone/api/inventory/plugin/collector.proto",
}

Collector_ServiceDesc is the grpc.ServiceDesc for Collector service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_spaceone_api_inventory_plugin_collector_proto protoreflect.FileDescriptor
View Source
var File_spaceone_api_inventory_plugin_job_proto protoreflect.FileDescriptor
View Source
var Job_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "spaceone.api.inventory.plugin.Job",
	HandlerType: (*JobServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "get_tasks",
			Handler:    _Job_GetTasks_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "spaceone/api/inventory/plugin/job.proto",
}

Job_ServiceDesc is the grpc.ServiceDesc for Job service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterCollectorServer

func RegisterCollectorServer(s grpc.ServiceRegistrar, srv CollectorServer)

func RegisterJobServer

func RegisterJobServer(s grpc.ServiceRegistrar, srv JobServer)

Types

type CollectRequest

type CollectRequest struct {
	Options     *_struct.Struct `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	SecretData  *_struct.Struct `protobuf:"bytes,2,opt,name=secret_data,json=secretData,proto3" json:"secret_data,omitempty"`
	Filter      *_struct.Struct `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	TaskOptions *_struct.Struct `protobuf:"bytes,4,opt,name=task_options,json=taskOptions,proto3" json:"task_options,omitempty"`
	// contains filtered or unexported fields
}

{

}

func (*CollectRequest) Descriptor deprecated

func (*CollectRequest) Descriptor() ([]byte, []int)

Deprecated: Use CollectRequest.ProtoReflect.Descriptor instead.

func (*CollectRequest) GetFilter

func (x *CollectRequest) GetFilter() *_struct.Struct

func (*CollectRequest) GetOptions

func (x *CollectRequest) GetOptions() *_struct.Struct

func (*CollectRequest) GetSecretData

func (x *CollectRequest) GetSecretData() *_struct.Struct

func (*CollectRequest) GetTaskOptions

func (x *CollectRequest) GetTaskOptions() *_struct.Struct

func (*CollectRequest) ProtoMessage

func (*CollectRequest) ProtoMessage()

func (*CollectRequest) ProtoReflect

func (x *CollectRequest) ProtoReflect() protoreflect.Message

func (*CollectRequest) Reset

func (x *CollectRequest) Reset()

func (*CollectRequest) String

func (x *CollectRequest) String() string

type CollectorClient

type CollectorClient interface {
	// Initializes a specific Collector. During initialization, the Collector information to be passed to the Collector user is delivered as `metadata`. Collector information includes its name and version.
	Init(ctx context.Context, in *InitRequest, opts ...grpc.CallOption) (*PluginInfo, error)
	// Verifies a specific Collector. You must specify the parameter `secret_data`, encrypted account data of the Collector to validate.
	Verify(ctx context.Context, in *VerifyRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Collects data of external infrastructure resources by a specific Collector.
	Collect(ctx context.Context, in *CollectRequest, opts ...grpc.CallOption) (Collector_CollectClient, error)
}

CollectorClient is the client API for Collector 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 NewCollectorClient

func NewCollectorClient(cc grpc.ClientConnInterface) CollectorClient

type CollectorServer

type CollectorServer interface {
	// Initializes a specific Collector. During initialization, the Collector information to be passed to the Collector user is delivered as `metadata`. Collector information includes its name and version.
	Init(context.Context, *InitRequest) (*PluginInfo, error)
	// Verifies a specific Collector. You must specify the parameter `secret_data`, encrypted account data of the Collector to validate.
	Verify(context.Context, *VerifyRequest) (*empty.Empty, error)
	// Collects data of external infrastructure resources by a specific Collector.
	Collect(*CollectRequest, Collector_CollectServer) error
	// contains filtered or unexported methods
}

CollectorServer is the server API for Collector service. All implementations must embed UnimplementedCollectorServer for forward compatibility

type CollectorVerifyInfo

type CollectorVerifyInfo struct {
	Options *_struct.Struct `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectorVerifyInfo) Descriptor deprecated

func (*CollectorVerifyInfo) Descriptor() ([]byte, []int)

Deprecated: Use CollectorVerifyInfo.ProtoReflect.Descriptor instead.

func (*CollectorVerifyInfo) GetOptions

func (x *CollectorVerifyInfo) GetOptions() *_struct.Struct

func (*CollectorVerifyInfo) ProtoMessage

func (*CollectorVerifyInfo) ProtoMessage()

func (*CollectorVerifyInfo) ProtoReflect

func (x *CollectorVerifyInfo) ProtoReflect() protoreflect.Message

func (*CollectorVerifyInfo) Reset

func (x *CollectorVerifyInfo) Reset()

func (*CollectorVerifyInfo) String

func (x *CollectorVerifyInfo) String() string

type Collector_CollectClient

type Collector_CollectClient interface {
	Recv() (*ResourceInfo, error)
	grpc.ClientStream
}

type Collector_CollectServer

type Collector_CollectServer interface {
	Send(*ResourceInfo) error
	grpc.ServerStream
}

type GetTaskRequest

type GetTaskRequest struct {
	SecretData *_struct.Struct `protobuf:"bytes,1,opt,name=secret_data,json=secretData,proto3" json:"secret_data,omitempty"`
	Options    *_struct.Struct `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	TaskFilter *TaskFilter     `protobuf:"bytes,3,opt,name=task_filter,json=taskFilter,proto3" json:"task_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTaskRequest) Descriptor deprecated

func (*GetTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.

func (*GetTaskRequest) GetOptions

func (x *GetTaskRequest) GetOptions() *_struct.Struct

func (*GetTaskRequest) GetSecretData

func (x *GetTaskRequest) GetSecretData() *_struct.Struct

func (*GetTaskRequest) GetTaskFilter

func (x *GetTaskRequest) GetTaskFilter() *TaskFilter

func (*GetTaskRequest) ProtoMessage

func (*GetTaskRequest) ProtoMessage()

func (*GetTaskRequest) ProtoReflect

func (x *GetTaskRequest) ProtoReflect() protoreflect.Message

func (*GetTaskRequest) Reset

func (x *GetTaskRequest) Reset()

func (*GetTaskRequest) String

func (x *GetTaskRequest) String() string

type InitRequest

type InitRequest struct {
	Options *_struct.Struct `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

{

}

func (*InitRequest) Descriptor deprecated

func (*InitRequest) Descriptor() ([]byte, []int)

Deprecated: Use InitRequest.ProtoReflect.Descriptor instead.

func (*InitRequest) GetOptions

func (x *InitRequest) GetOptions() *_struct.Struct

func (*InitRequest) ProtoMessage

func (*InitRequest) ProtoMessage()

func (*InitRequest) ProtoReflect

func (x *InitRequest) ProtoReflect() protoreflect.Message

func (*InitRequest) Reset

func (x *InitRequest) Reset()

func (*InitRequest) String

func (x *InitRequest) String() string

type JobClient

type JobClient interface {
	GetTasks(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*TasksInfo, error)
}

JobClient is the client API for Job 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 NewJobClient

func NewJobClient(cc grpc.ClientConnInterface) JobClient

type JobServer

type JobServer interface {
	GetTasks(context.Context, *GetTaskRequest) (*TasksInfo, error)
	// contains filtered or unexported methods
}

JobServer is the server API for Job service. All implementations must embed UnimplementedJobServer for forward compatibility

type PluginInfo

type PluginInfo struct {
	Metadata *_struct.Struct `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

{

}

func (*PluginInfo) Descriptor deprecated

func (*PluginInfo) Descriptor() ([]byte, []int)

Deprecated: Use PluginInfo.ProtoReflect.Descriptor instead.

func (*PluginInfo) GetMetadata

func (x *PluginInfo) GetMetadata() *_struct.Struct

func (*PluginInfo) ProtoMessage

func (*PluginInfo) ProtoMessage()

func (*PluginInfo) ProtoReflect

func (x *PluginInfo) ProtoReflect() protoreflect.Message

func (*PluginInfo) Reset

func (x *PluginInfo) Reset()

func (*PluginInfo) String

func (x *PluginInfo) String() string

type ResourceInfo

type ResourceInfo struct {
	State        ResourceInfo_State `protobuf:"varint,1,opt,name=state,proto3,enum=spaceone.api.inventory.plugin.ResourceInfo_State" json:"state,omitempty"`
	Message      string             `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	ResourceType string             `protobuf:"bytes,3,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`
	MatchRules   *_struct.Struct    `protobuf:"bytes,4,opt,name=match_rules,json=matchRules,proto3" json:"match_rules,omitempty"`
	Resource     *_struct.Struct    `protobuf:"bytes,6,opt,name=resource,proto3" json:"resource,omitempty"`
	Options      *_struct.Struct    `protobuf:"bytes,7,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

func (*ResourceInfo) Descriptor deprecated

func (*ResourceInfo) Descriptor() ([]byte, []int)

Deprecated: Use ResourceInfo.ProtoReflect.Descriptor instead.

func (*ResourceInfo) GetMatchRules

func (x *ResourceInfo) GetMatchRules() *_struct.Struct

func (*ResourceInfo) GetMessage

func (x *ResourceInfo) GetMessage() string

func (*ResourceInfo) GetOptions

func (x *ResourceInfo) GetOptions() *_struct.Struct

func (*ResourceInfo) GetResource

func (x *ResourceInfo) GetResource() *_struct.Struct

func (*ResourceInfo) GetResourceType

func (x *ResourceInfo) GetResourceType() string

func (*ResourceInfo) GetState

func (x *ResourceInfo) GetState() ResourceInfo_State

func (*ResourceInfo) ProtoMessage

func (*ResourceInfo) ProtoMessage()

func (*ResourceInfo) ProtoReflect

func (x *ResourceInfo) ProtoReflect() protoreflect.Message

func (*ResourceInfo) Reset

func (x *ResourceInfo) Reset()

func (*ResourceInfo) String

func (x *ResourceInfo) String() string

type ResourceInfo_State

type ResourceInfo_State int32
const (
	ResourceInfo_NONE       ResourceInfo_State = 0
	ResourceInfo_CREATED    ResourceInfo_State = 1
	ResourceInfo_PENDING    ResourceInfo_State = 2
	ResourceInfo_INPROGRESS ResourceInfo_State = 3
	ResourceInfo_SUCCESS    ResourceInfo_State = 4
	ResourceInfo_FAILURE    ResourceInfo_State = 5
	ResourceInfo_TIMEOUT    ResourceInfo_State = 6
	ResourceInfo_IDLE       ResourceInfo_State = 7
	ResourceInfo_SKIP       ResourceInfo_State = 8
)

func (ResourceInfo_State) Descriptor

func (ResourceInfo_State) Enum

func (ResourceInfo_State) EnumDescriptor deprecated

func (ResourceInfo_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ResourceInfo_State.Descriptor instead.

func (ResourceInfo_State) Number

func (ResourceInfo_State) String

func (x ResourceInfo_State) String() string

func (ResourceInfo_State) Type

type TaskFilter

type TaskFilter struct {
	Providers          []string `protobuf:"bytes,1,rep,name=providers,proto3" json:"providers,omitempty"`
	CloudServiceGroups []string `protobuf:"bytes,2,rep,name=cloud_service_groups,json=cloudServiceGroups,proto3" json:"cloud_service_groups,omitempty"`
	CloudServiceTypes  []string `protobuf:"bytes,3,rep,name=cloud_service_types,json=cloudServiceTypes,proto3" json:"cloud_service_types,omitempty"`
	RegionCodes        []string `protobuf:"bytes,4,rep,name=region_codes,json=regionCodes,proto3" json:"region_codes,omitempty"`
	Resources          []string `protobuf:"bytes,5,rep,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

func (*TaskFilter) Descriptor deprecated

func (*TaskFilter) Descriptor() ([]byte, []int)

Deprecated: Use TaskFilter.ProtoReflect.Descriptor instead.

func (*TaskFilter) GetCloudServiceGroups

func (x *TaskFilter) GetCloudServiceGroups() []string

func (*TaskFilter) GetCloudServiceTypes

func (x *TaskFilter) GetCloudServiceTypes() []string

func (*TaskFilter) GetProviders

func (x *TaskFilter) GetProviders() []string

func (*TaskFilter) GetRegionCodes

func (x *TaskFilter) GetRegionCodes() []string

func (*TaskFilter) GetResources

func (x *TaskFilter) GetResources() []string

func (*TaskFilter) ProtoMessage

func (*TaskFilter) ProtoMessage()

func (*TaskFilter) ProtoReflect

func (x *TaskFilter) ProtoReflect() protoreflect.Message

func (*TaskFilter) Reset

func (x *TaskFilter) Reset()

func (*TaskFilter) String

func (x *TaskFilter) String() string

type TaskInfo

type TaskInfo struct {
	TaskOptions *_struct.Struct `protobuf:"bytes,1,opt,name=task_options,json=taskOptions,proto3" json:"task_options,omitempty"`
	// contains filtered or unexported fields
}

func (*TaskInfo) Descriptor deprecated

func (*TaskInfo) Descriptor() ([]byte, []int)

Deprecated: Use TaskInfo.ProtoReflect.Descriptor instead.

func (*TaskInfo) GetTaskOptions

func (x *TaskInfo) GetTaskOptions() *_struct.Struct

func (*TaskInfo) ProtoMessage

func (*TaskInfo) ProtoMessage()

func (*TaskInfo) ProtoReflect

func (x *TaskInfo) ProtoReflect() protoreflect.Message

func (*TaskInfo) Reset

func (x *TaskInfo) Reset()

func (*TaskInfo) String

func (x *TaskInfo) String() string

type TasksInfo

type TasksInfo struct {
	Tasks []*TaskInfo `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

func (*TasksInfo) Descriptor deprecated

func (*TasksInfo) Descriptor() ([]byte, []int)

Deprecated: Use TasksInfo.ProtoReflect.Descriptor instead.

func (*TasksInfo) GetTasks

func (x *TasksInfo) GetTasks() []*TaskInfo

func (*TasksInfo) ProtoMessage

func (*TasksInfo) ProtoMessage()

func (*TasksInfo) ProtoReflect

func (x *TasksInfo) ProtoReflect() protoreflect.Message

func (*TasksInfo) Reset

func (x *TasksInfo) Reset()

func (*TasksInfo) String

func (x *TasksInfo) String() string

type UnimplementedCollectorServer

type UnimplementedCollectorServer struct {
}

UnimplementedCollectorServer must be embedded to have forward compatible implementations.

func (UnimplementedCollectorServer) Collect

func (UnimplementedCollectorServer) Init

func (UnimplementedCollectorServer) Verify

type UnimplementedJobServer

type UnimplementedJobServer struct {
}

UnimplementedJobServer must be embedded to have forward compatible implementations.

func (UnimplementedJobServer) GetTasks

type UnsafeCollectorServer

type UnsafeCollectorServer interface {
	// contains filtered or unexported methods
}

UnsafeCollectorServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CollectorServer will result in compilation errors.

type UnsafeJobServer

type UnsafeJobServer interface {
	// contains filtered or unexported methods
}

UnsafeJobServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JobServer will result in compilation errors.

type VerifyRequest

type VerifyRequest struct {
	Options    *_struct.Struct `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	SecretData *_struct.Struct `protobuf:"bytes,2,opt,name=secret_data,json=secretData,proto3" json:"secret_data,omitempty"`
	// contains filtered or unexported fields
}

{

}

func (*VerifyRequest) Descriptor deprecated

func (*VerifyRequest) Descriptor() ([]byte, []int)

Deprecated: Use VerifyRequest.ProtoReflect.Descriptor instead.

func (*VerifyRequest) GetOptions

func (x *VerifyRequest) GetOptions() *_struct.Struct

func (*VerifyRequest) GetSecretData

func (x *VerifyRequest) GetSecretData() *_struct.Struct

func (*VerifyRequest) ProtoMessage

func (*VerifyRequest) ProtoMessage()

func (*VerifyRequest) ProtoReflect

func (x *VerifyRequest) ProtoReflect() protoreflect.Message

func (*VerifyRequest) Reset

func (x *VerifyRequest) Reset()

func (*VerifyRequest) String

func (x *VerifyRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL