Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterConsoleproxyServiceServer(s grpc.ServiceRegistrar, srv ConsoleproxyServiceServer)
- type ConsoleproxyServiceClient
- type ConsoleproxyServiceServer
- type CreateConsoleEndpointRequest
- func (*CreateConsoleEndpointRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateConsoleEndpointRequest) GetExtraSecurityToken() string
- func (x *CreateConsoleEndpointRequest) GetResponseType() string
- func (x *CreateConsoleEndpointRequest) GetVmId() int64
- func (*CreateConsoleEndpointRequest) ProtoMessage()
- func (x *CreateConsoleEndpointRequest) ProtoReflect() protoreflect.Message
- func (x *CreateConsoleEndpointRequest) Reset()
- func (x *CreateConsoleEndpointRequest) String() string
- type CreateConsoleEndpointResponse
- func (*CreateConsoleEndpointResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateConsoleEndpointResponse) GetResult() *Result
- func (*CreateConsoleEndpointResponse) ProtoMessage()
- func (x *CreateConsoleEndpointResponse) ProtoReflect() protoreflect.Message
- func (x *CreateConsoleEndpointResponse) Reset()
- func (x *CreateConsoleEndpointResponse) 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 Success
- type UnimplementedConsoleproxyServiceServer
- type UnsafeConsoleproxyServiceServer
Constants ¶
const (
ConsoleproxyService_CreateConsoleEndpoint_FullMethodName = "/cloudstack.management.consoleproxy.v1.ConsoleproxyService/CreateConsoleEndpoint"
)
Variables ¶
var ConsoleproxyService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "cloudstack.management.consoleproxy.v1.ConsoleproxyService", HandlerType: (*ConsoleproxyServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateConsoleEndpoint", Handler: _ConsoleproxyService_CreateConsoleEndpoint_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "cloudstack/management/consoleproxy/v1/consoleproxy.gen.proto", }
ConsoleproxyService_ServiceDesc is the grpc.ServiceDesc for ConsoleproxyService 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_consoleproxy_v1_consoleproxy_gen_proto protoreflect.FileDescriptor
Functions ¶
func RegisterConsoleproxyServiceServer ¶
func RegisterConsoleproxyServiceServer(s grpc.ServiceRegistrar, srv ConsoleproxyServiceServer)
Types ¶
type ConsoleproxyServiceClient ¶
type ConsoleproxyServiceClient interface { // CreateConsoleEndpoint Create a console endpoint to connect to a VM console CreateConsoleEndpoint(ctx context.Context, in *CreateConsoleEndpointRequest, opts ...grpc.CallOption) (*CreateConsoleEndpointResponse, error) }
ConsoleproxyServiceClient is the client API for ConsoleproxyService 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.
ConsoleproxyService provides operations for managing Consoleproxys
func NewConsoleproxyServiceClient ¶
func NewConsoleproxyServiceClient(cc grpc.ClientConnInterface) ConsoleproxyServiceClient
type ConsoleproxyServiceServer ¶
type ConsoleproxyServiceServer interface { // CreateConsoleEndpoint Create a console endpoint to connect to a VM console CreateConsoleEndpoint(context.Context, *CreateConsoleEndpointRequest) (*CreateConsoleEndpointResponse, error) // contains filtered or unexported methods }
ConsoleproxyServiceServer is the server API for ConsoleproxyService service. All implementations must embed UnimplementedConsoleproxyServiceServer for forward compatibility.
ConsoleproxyService provides operations for managing Consoleproxys
type CreateConsoleEndpointRequest ¶
type CreateConsoleEndpointRequest struct { // ID of the VM VmId *int64 `protobuf:"varint,1,opt,name=vm_id,json=vmId" json:"vm_id,omitempty"` // (optional) extra security token, valid when the extra validation is enabled ExtraSecurityToken *string `protobuf:"bytes,2,opt,name=extra_security_token,json=extraSecurityToken" json:"extra_security_token,omitempty"` ResponseType *string `protobuf:"bytes,3,opt,name=response_type,json=responseType" json:"response_type,omitempty"` // contains filtered or unexported fields }
CreateConsoleEndpointRequest represents the parameters for create a console endpoint to connect to a vm console
func (*CreateConsoleEndpointRequest) Descriptor
deprecated
func (*CreateConsoleEndpointRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateConsoleEndpointRequest.ProtoReflect.Descriptor instead.
func (*CreateConsoleEndpointRequest) GetExtraSecurityToken ¶
func (x *CreateConsoleEndpointRequest) GetExtraSecurityToken() string
func (*CreateConsoleEndpointRequest) GetResponseType ¶
func (x *CreateConsoleEndpointRequest) GetResponseType() string
func (*CreateConsoleEndpointRequest) GetVmId ¶
func (x *CreateConsoleEndpointRequest) GetVmId() int64
func (*CreateConsoleEndpointRequest) ProtoMessage ¶
func (*CreateConsoleEndpointRequest) ProtoMessage()
func (*CreateConsoleEndpointRequest) ProtoReflect ¶
func (x *CreateConsoleEndpointRequest) ProtoReflect() protoreflect.Message
func (*CreateConsoleEndpointRequest) Reset ¶
func (x *CreateConsoleEndpointRequest) Reset()
func (*CreateConsoleEndpointRequest) String ¶
func (x *CreateConsoleEndpointRequest) String() string
type CreateConsoleEndpointResponse ¶
type CreateConsoleEndpointResponse struct { // The Result Result *Result `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"` // contains filtered or unexported fields }
CreateConsoleEndpointResponse represents the response from create a console endpoint to connect to a vm console
func (*CreateConsoleEndpointResponse) Descriptor
deprecated
func (*CreateConsoleEndpointResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateConsoleEndpointResponse.ProtoReflect.Descriptor instead.
func (*CreateConsoleEndpointResponse) GetResult ¶
func (x *CreateConsoleEndpointResponse) GetResult() *Result
func (*CreateConsoleEndpointResponse) ProtoMessage ¶
func (*CreateConsoleEndpointResponse) ProtoMessage()
func (*CreateConsoleEndpointResponse) ProtoReflect ¶
func (x *CreateConsoleEndpointResponse) ProtoReflect() protoreflect.Message
func (*CreateConsoleEndpointResponse) Reset ¶
func (x *CreateConsoleEndpointResponse) Reset()
func (*CreateConsoleEndpointResponse) String ¶
func (x *CreateConsoleEndpointResponse) 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 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 UnimplementedConsoleproxyServiceServer ¶
type UnimplementedConsoleproxyServiceServer struct{}
UnimplementedConsoleproxyServiceServer 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 (UnimplementedConsoleproxyServiceServer) CreateConsoleEndpoint ¶
func (UnimplementedConsoleproxyServiceServer) CreateConsoleEndpoint(context.Context, *CreateConsoleEndpointRequest) (*CreateConsoleEndpointResponse, error)
type UnsafeConsoleproxyServiceServer ¶
type UnsafeConsoleproxyServiceServer interface {
// contains filtered or unexported methods
}
UnsafeConsoleproxyServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConsoleproxyServiceServer will result in compilation errors.