Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterDiagnosticsServiceServer(s grpc.ServiceRegistrar, srv DiagnosticsServiceServer)
- type DiagnosticsServiceClient
- type DiagnosticsServiceServer
- type GetDiagnosticsDataRequest
- func (*GetDiagnosticsDataRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetDiagnosticsDataRequest) GetFilesList() []string
- func (x *GetDiagnosticsDataRequest) GetId() int64
- func (x *GetDiagnosticsDataRequest) GetInjectedJobId() string
- func (x *GetDiagnosticsDataRequest) GetResponseType() string
- func (x *GetDiagnosticsDataRequest) GetStartEventId() int64
- func (*GetDiagnosticsDataRequest) ProtoMessage()
- func (x *GetDiagnosticsDataRequest) ProtoReflect() protoreflect.Message
- func (x *GetDiagnosticsDataRequest) Reset()
- func (x *GetDiagnosticsDataRequest) String() string
- type GetDiagnosticsDataResponse
- func (*GetDiagnosticsDataResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetDiagnosticsDataResponse) GetResult() *Result
- func (*GetDiagnosticsDataResponse) ProtoMessage()
- func (x *GetDiagnosticsDataResponse) ProtoReflect() protoreflect.Message
- func (x *GetDiagnosticsDataResponse) Reset()
- func (x *GetDiagnosticsDataResponse) String() string
- type Result
- func (*Result) Descriptor() ([]byte, []int)deprecated
- func (x *Result) GetDisplayText() string
- func (x *Result) GetId() string
- func (x *Result) GetJobId() string
- func (x *Result) GetJobStatus() string
- func (x *Result) GetSuccess() bool
- func (*Result) ProtoMessage()
- func (x *Result) ProtoReflect() protoreflect.Message
- func (x *Result) Reset()
- func (x *Result) String() string
- type RunDiagnosticsRequest
- func (*RunDiagnosticsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RunDiagnosticsRequest) GetAddress() string
- func (x *RunDiagnosticsRequest) GetId() int64
- func (x *RunDiagnosticsRequest) GetInjectedJobId() string
- func (x *RunDiagnosticsRequest) GetOptionalArguments_() string
- func (x *RunDiagnosticsRequest) GetResponseType() string
- func (x *RunDiagnosticsRequest) GetStartEventId() int64
- func (x *RunDiagnosticsRequest) GetType() string
- func (*RunDiagnosticsRequest) ProtoMessage()
- func (x *RunDiagnosticsRequest) ProtoReflect() protoreflect.Message
- func (x *RunDiagnosticsRequest) Reset()
- func (x *RunDiagnosticsRequest) String() string
- type RunDiagnosticsResponse
- func (*RunDiagnosticsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RunDiagnosticsResponse) GetResult() *Result
- func (*RunDiagnosticsResponse) ProtoMessage()
- func (x *RunDiagnosticsResponse) ProtoReflect() protoreflect.Message
- func (x *RunDiagnosticsResponse) Reset()
- func (x *RunDiagnosticsResponse) String() string
- type Success
- type UnimplementedDiagnosticsServiceServer
- type UnsafeDiagnosticsServiceServer
Constants ¶
const ( DiagnosticsService_GetDiagnosticsData_FullMethodName = "/cloudstack.management.diagnostics.v1.DiagnosticsService/GetDiagnosticsData" DiagnosticsService_RunDiagnostics_FullMethodName = "/cloudstack.management.diagnostics.v1.DiagnosticsService/RunDiagnostics" )
Variables ¶
var DiagnosticsService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "cloudstack.management.diagnostics.v1.DiagnosticsService", HandlerType: (*DiagnosticsServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetDiagnosticsData", Handler: _DiagnosticsService_GetDiagnosticsData_Handler, }, { MethodName: "RunDiagnostics", Handler: _DiagnosticsService_RunDiagnostics_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "cloudstack/management/diagnostics/v1/diagnostics.gen.proto", }
DiagnosticsService_ServiceDesc is the grpc.ServiceDesc for DiagnosticsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_cloudstack_management_diagnostics_v1_diagnostics_gen_proto protoreflect.FileDescriptor
Functions ¶
func RegisterDiagnosticsServiceServer ¶
func RegisterDiagnosticsServiceServer(s grpc.ServiceRegistrar, srv DiagnosticsServiceServer)
Types ¶
type DiagnosticsServiceClient ¶
type DiagnosticsServiceClient interface { // GetDiagnosticsData Get diagnostics and files from system VMs GetDiagnosticsData(ctx context.Context, in *GetDiagnosticsDataRequest, opts ...grpc.CallOption) (*GetDiagnosticsDataResponse, error) // RunDiagnostics Execute network-utility command (ping/arping/tracert) on system VMs remotely RunDiagnostics(ctx context.Context, in *RunDiagnosticsRequest, opts ...grpc.CallOption) (*RunDiagnosticsResponse, error) }
DiagnosticsServiceClient is the client API for DiagnosticsService 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.
DiagnosticsService provides operations for managing Diagnosticss
func NewDiagnosticsServiceClient ¶
func NewDiagnosticsServiceClient(cc grpc.ClientConnInterface) DiagnosticsServiceClient
type DiagnosticsServiceServer ¶
type DiagnosticsServiceServer interface { // GetDiagnosticsData Get diagnostics and files from system VMs GetDiagnosticsData(context.Context, *GetDiagnosticsDataRequest) (*GetDiagnosticsDataResponse, error) // RunDiagnostics Execute network-utility command (ping/arping/tracert) on system VMs remotely RunDiagnostics(context.Context, *RunDiagnosticsRequest) (*RunDiagnosticsResponse, error) // contains filtered or unexported methods }
DiagnosticsServiceServer is the server API for DiagnosticsService service. All implementations must embed UnimplementedDiagnosticsServiceServer for forward compatibility.
DiagnosticsService provides operations for managing Diagnosticss
type GetDiagnosticsDataRequest ¶
type GetDiagnosticsDataRequest struct { // The ID of the system VM instance to retrieve diagnostics data files from Id *int64 `protobuf:"varint,1,opt,name=id" json:"id,omitempty"` // A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. FilesList []string `protobuf:"bytes,2,rep,name=files_list,json=filesList" json:"files_list,omitempty"` StartEventId *int64 `protobuf:"varint,3,opt,name=start_event_id,json=startEventId" json:"start_event_id,omitempty"` InjectedJobId *string `protobuf:"bytes,4,opt,name=injected_job_id,json=injectedJobId" json:"injected_job_id,omitempty"` ResponseType *string `protobuf:"bytes,5,opt,name=response_type,json=responseType" json:"response_type,omitempty"` // contains filtered or unexported fields }
GetDiagnosticsDataRequest represents the parameters for get diagnostics and files from system vms
func (*GetDiagnosticsDataRequest) Descriptor
deprecated
func (*GetDiagnosticsDataRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDiagnosticsDataRequest.ProtoReflect.Descriptor instead.
func (*GetDiagnosticsDataRequest) GetFilesList ¶
func (x *GetDiagnosticsDataRequest) GetFilesList() []string
func (*GetDiagnosticsDataRequest) GetId ¶
func (x *GetDiagnosticsDataRequest) GetId() int64
func (*GetDiagnosticsDataRequest) GetInjectedJobId ¶
func (x *GetDiagnosticsDataRequest) GetInjectedJobId() string
func (*GetDiagnosticsDataRequest) GetResponseType ¶
func (x *GetDiagnosticsDataRequest) GetResponseType() string
func (*GetDiagnosticsDataRequest) GetStartEventId ¶
func (x *GetDiagnosticsDataRequest) GetStartEventId() int64
func (*GetDiagnosticsDataRequest) ProtoMessage ¶
func (*GetDiagnosticsDataRequest) ProtoMessage()
func (*GetDiagnosticsDataRequest) ProtoReflect ¶
func (x *GetDiagnosticsDataRequest) ProtoReflect() protoreflect.Message
func (*GetDiagnosticsDataRequest) Reset ¶
func (x *GetDiagnosticsDataRequest) Reset()
func (*GetDiagnosticsDataRequest) String ¶
func (x *GetDiagnosticsDataRequest) String() string
type GetDiagnosticsDataResponse ¶
type GetDiagnosticsDataResponse struct { // The Result Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"` // contains filtered or unexported fields }
GetDiagnosticsDataResponse represents the response from get diagnostics and files from system vms
func (*GetDiagnosticsDataResponse) Descriptor
deprecated
func (*GetDiagnosticsDataResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetDiagnosticsDataResponse.ProtoReflect.Descriptor instead.
func (*GetDiagnosticsDataResponse) GetResult ¶
func (x *GetDiagnosticsDataResponse) GetResult() *Result
func (*GetDiagnosticsDataResponse) ProtoMessage ¶
func (*GetDiagnosticsDataResponse) ProtoMessage()
func (*GetDiagnosticsDataResponse) ProtoReflect ¶
func (x *GetDiagnosticsDataResponse) ProtoReflect() protoreflect.Message
func (*GetDiagnosticsDataResponse) Reset ¶
func (x *GetDiagnosticsDataResponse) Reset()
func (*GetDiagnosticsDataResponse) String ¶
func (x *GetDiagnosticsDataResponse) String() string
type Result ¶
type Result struct { // Whether the operation was successful Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"` // Any text associated with the success or failure DisplayText *string `protobuf:"bytes,2,opt,name=display_text,json=displayText" json:"display_text,omitempty"` // The ID of the resource affected by the operation Id *string `protobuf:"bytes,3,opt,name=id" json:"id,omitempty"` // The job ID for an async operation JobId *string `protobuf:"bytes,4,opt,name=job_id,json=jobId" json:"job_id,omitempty"` // The status of the job JobStatus *string `protobuf:"bytes,5,opt,name=job_status,json=jobStatus" json:"job_status,omitempty"` // contains filtered or unexported fields }
Result represents a generic operation result
func (*Result) Descriptor
deprecated
func (*Result) GetDisplayText ¶
func (*Result) GetJobStatus ¶
func (*Result) GetSuccess ¶
func (*Result) ProtoMessage ¶
func (*Result) ProtoMessage()
func (*Result) ProtoReflect ¶
func (x *Result) ProtoReflect() protoreflect.Message
type RunDiagnosticsRequest ¶
type RunDiagnosticsRequest struct { // The ID of the system VM instance to diagnose Id *int64 `protobuf:"varint,1,opt,name=id" json:"id,omitempty"` // The IP/Domain address to test connection to Address *string `protobuf:"bytes,2,opt,name=address" json:"address,omitempty"` // The system VM diagnostics type valid options are: ping, traceroute, arping Type *string `protobuf:"bytes,3,opt,name=type" json:"type,omitempty"` // Additional command line options that apply for each command OptionalArguments_ *string `protobuf:"bytes,4,opt,name=optional_arguments_,json=optionalArguments" json:"optional_arguments_,omitempty"` StartEventId *int64 `protobuf:"varint,5,opt,name=start_event_id,json=startEventId" json:"start_event_id,omitempty"` InjectedJobId *string `protobuf:"bytes,6,opt,name=injected_job_id,json=injectedJobId" json:"injected_job_id,omitempty"` ResponseType *string `protobuf:"bytes,7,opt,name=response_type,json=responseType" json:"response_type,omitempty"` // contains filtered or unexported fields }
RunDiagnosticsRequest represents the parameters for execute network-utility command (ping/arping/tracert) on system vms remotely
func (*RunDiagnosticsRequest) Descriptor
deprecated
func (*RunDiagnosticsRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunDiagnosticsRequest.ProtoReflect.Descriptor instead.
func (*RunDiagnosticsRequest) GetAddress ¶
func (x *RunDiagnosticsRequest) GetAddress() string
func (*RunDiagnosticsRequest) GetId ¶
func (x *RunDiagnosticsRequest) GetId() int64
func (*RunDiagnosticsRequest) GetInjectedJobId ¶
func (x *RunDiagnosticsRequest) GetInjectedJobId() string
func (*RunDiagnosticsRequest) GetOptionalArguments_ ¶
func (x *RunDiagnosticsRequest) GetOptionalArguments_() string
func (*RunDiagnosticsRequest) GetResponseType ¶
func (x *RunDiagnosticsRequest) GetResponseType() string
func (*RunDiagnosticsRequest) GetStartEventId ¶
func (x *RunDiagnosticsRequest) GetStartEventId() int64
func (*RunDiagnosticsRequest) GetType ¶
func (x *RunDiagnosticsRequest) GetType() string
func (*RunDiagnosticsRequest) ProtoMessage ¶
func (*RunDiagnosticsRequest) ProtoMessage()
func (*RunDiagnosticsRequest) ProtoReflect ¶
func (x *RunDiagnosticsRequest) ProtoReflect() protoreflect.Message
func (*RunDiagnosticsRequest) Reset ¶
func (x *RunDiagnosticsRequest) Reset()
func (*RunDiagnosticsRequest) String ¶
func (x *RunDiagnosticsRequest) String() string
type RunDiagnosticsResponse ¶
type RunDiagnosticsResponse struct { // The Result Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"` // contains filtered or unexported fields }
RunDiagnosticsResponse represents the response from execute network-utility command (ping/arping/tracert) on system vms remotely
func (*RunDiagnosticsResponse) Descriptor
deprecated
func (*RunDiagnosticsResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunDiagnosticsResponse.ProtoReflect.Descriptor instead.
func (*RunDiagnosticsResponse) GetResult ¶
func (x *RunDiagnosticsResponse) GetResult() *Result
func (*RunDiagnosticsResponse) ProtoMessage ¶
func (*RunDiagnosticsResponse) ProtoMessage()
func (*RunDiagnosticsResponse) ProtoReflect ¶
func (x *RunDiagnosticsResponse) ProtoReflect() protoreflect.Message
func (*RunDiagnosticsResponse) Reset ¶
func (x *RunDiagnosticsResponse) Reset()
func (*RunDiagnosticsResponse) String ¶
func (x *RunDiagnosticsResponse) String() string
type Success ¶
type Success struct { // true if operation is executed successfully Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"` // any text associated with the success or failure DisplayText *string `protobuf:"bytes,2,opt,name=display_text,json=displayText" json:"display_text,omitempty"` // contains filtered or unexported fields }
Success represents a Success Operation Response
func (*Success) Descriptor
deprecated
func (*Success) GetDisplayText ¶
func (*Success) GetSuccess ¶
func (*Success) ProtoMessage ¶
func (*Success) ProtoMessage()
func (*Success) ProtoReflect ¶
func (x *Success) ProtoReflect() protoreflect.Message
type UnimplementedDiagnosticsServiceServer ¶
type UnimplementedDiagnosticsServiceServer struct{}
UnimplementedDiagnosticsServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedDiagnosticsServiceServer) GetDiagnosticsData ¶
func (UnimplementedDiagnosticsServiceServer) GetDiagnosticsData(context.Context, *GetDiagnosticsDataRequest) (*GetDiagnosticsDataResponse, error)
func (UnimplementedDiagnosticsServiceServer) RunDiagnostics ¶
func (UnimplementedDiagnosticsServiceServer) RunDiagnostics(context.Context, *RunDiagnosticsRequest) (*RunDiagnosticsResponse, error)
type UnsafeDiagnosticsServiceServer ¶
type UnsafeDiagnosticsServiceServer interface {
// contains filtered or unexported methods
}
UnsafeDiagnosticsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DiagnosticsServiceServer will result in compilation errors.