Documentation
¶
Index ¶
- Variables
- func RegisterFactoryResetServer(s *grpc.Server, srv FactoryResetServer)
- type FactoryResetClient
- type FactoryResetServer
- type ResetError
- func (*ResetError) Descriptor() ([]byte, []int)deprecated
- func (x *ResetError) GetDetail() string
- func (x *ResetError) GetFactoryOsUnsupported() bool
- func (x *ResetError) GetOther() bool
- func (x *ResetError) GetZeroFillUnsupported() bool
- func (*ResetError) ProtoMessage()
- func (x *ResetError) ProtoReflect() protoreflect.Message
- func (x *ResetError) Reset()
- func (x *ResetError) String() string
- type ResetSuccess
- type StartRequest
- func (*StartRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StartRequest) GetFactoryOs() bool
- func (x *StartRequest) GetZeroFill() bool
- func (*StartRequest) ProtoMessage()
- func (x *StartRequest) ProtoReflect() protoreflect.Message
- func (x *StartRequest) Reset()
- func (x *StartRequest) String() string
- type StartResponse
- func (*StartResponse) Descriptor() ([]byte, []int)deprecated
- func (x *StartResponse) GetResetError() *ResetError
- func (x *StartResponse) GetResetSuccess() *ResetSuccess
- func (m *StartResponse) GetResponse() isStartResponse_Response
- func (*StartResponse) ProtoMessage()
- func (x *StartResponse) ProtoReflect() protoreflect.Message
- func (x *StartResponse) Reset()
- func (x *StartResponse) String() string
- type StartResponse_ResetError
- type StartResponse_ResetSuccess
- type UnimplementedFactoryResetServer
Constants ¶
This section is empty.
Variables ¶
View Source
var File_reset_proto protoreflect.FileDescriptor
Functions ¶
func RegisterFactoryResetServer ¶
func RegisterFactoryResetServer(s *grpc.Server, srv FactoryResetServer)
Types ¶
type FactoryResetClient ¶
type FactoryResetClient interface {
// The Start RPC allows the Client to instruct the Target to immediately
// clean all existing state and boot the Target in the same condition as it is
// shipped from factory. State includes storage, configuration, logs,
// certificates and licenses.
//
// Optionally allows rolling back the OS to the same version shipped from
// factory.
//
// Optionally allows for the Target to zero-fill permanent storage where state
// data is stored.
//
// If any of the optional flags is set but not supported, a gRPC Status with
// code INVALID_ARGUMENT must be returned with the details value set to a
// properly populated ResetError message.
Start(ctx context.Context, in *StartRequest, opts ...grpc.CallOption) (*StartResponse, error)
}
FactoryResetClient is the client API for FactoryReset service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewFactoryResetClient ¶
func NewFactoryResetClient(cc grpc.ClientConnInterface) FactoryResetClient
type FactoryResetServer ¶
type FactoryResetServer interface {
// The Start RPC allows the Client to instruct the Target to immediately
// clean all existing state and boot the Target in the same condition as it is
// shipped from factory. State includes storage, configuration, logs,
// certificates and licenses.
//
// Optionally allows rolling back the OS to the same version shipped from
// factory.
//
// Optionally allows for the Target to zero-fill permanent storage where state
// data is stored.
//
// If any of the optional flags is set but not supported, a gRPC Status with
// code INVALID_ARGUMENT must be returned with the details value set to a
// properly populated ResetError message.
Start(context.Context, *StartRequest) (*StartResponse, error)
}
FactoryResetServer is the server API for FactoryReset service.
type ResetError ¶
type ResetError struct {
// Factory OS reset is not supported.
FactoryOsUnsupported bool `protobuf:"varint,1,opt,name=factory_os_unsupported,json=factoryOsUnsupported,proto3" json:"factory_os_unsupported,omitempty"`
// Zero fill is not supported.
ZeroFillUnsupported bool `protobuf:"varint,2,opt,name=zero_fill_unsupported,json=zeroFillUnsupported,proto3" json:"zero_fill_unsupported,omitempty"`
// Unspecified error, must provide detail message.
Other bool `protobuf:"varint,3,opt,name=other,proto3" json:"other,omitempty"`
Detail string `protobuf:"bytes,4,opt,name=detail,proto3" json:"detail,omitempty"`
// contains filtered or unexported fields
}
Message also used in gRPC status.details field.
func (*ResetError) Descriptor
deprecated
func (*ResetError) Descriptor() ([]byte, []int)
Deprecated: Use ResetError.ProtoReflect.Descriptor instead.
func (*ResetError) GetDetail ¶
func (x *ResetError) GetDetail() string
func (*ResetError) GetFactoryOsUnsupported ¶
func (x *ResetError) GetFactoryOsUnsupported() bool
func (*ResetError) GetOther ¶
func (x *ResetError) GetOther() bool
func (*ResetError) GetZeroFillUnsupported ¶
func (x *ResetError) GetZeroFillUnsupported() bool
func (*ResetError) ProtoMessage ¶
func (*ResetError) ProtoMessage()
func (*ResetError) ProtoReflect ¶
func (x *ResetError) ProtoReflect() protoreflect.Message
func (*ResetError) Reset ¶
func (x *ResetError) Reset()
func (*ResetError) String ¶
func (x *ResetError) String() string
type ResetSuccess ¶
type ResetSuccess struct {
// contains filtered or unexported fields
}
func (*ResetSuccess) Descriptor
deprecated
func (*ResetSuccess) Descriptor() ([]byte, []int)
Deprecated: Use ResetSuccess.ProtoReflect.Descriptor instead.
func (*ResetSuccess) ProtoMessage ¶
func (*ResetSuccess) ProtoMessage()
func (*ResetSuccess) ProtoReflect ¶
func (x *ResetSuccess) ProtoReflect() protoreflect.Message
func (*ResetSuccess) Reset ¶
func (x *ResetSuccess) Reset()
func (*ResetSuccess) String ¶
func (x *ResetSuccess) String() string
type StartRequest ¶
type StartRequest struct {
// Instructs the Target to rollback the OS to the same version as it shipped
// from factory.
FactoryOs bool `protobuf:"varint,1,opt,name=factory_os,json=factoryOs,proto3" json:"factory_os,omitempty"`
// Instructs the Target to zero fill persistent storage state data.
ZeroFill bool `protobuf:"varint,2,opt,name=zero_fill,json=zeroFill,proto3" json:"zero_fill,omitempty"`
// contains filtered or unexported fields
}
func (*StartRequest) Descriptor
deprecated
func (*StartRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartRequest.ProtoReflect.Descriptor instead.
func (*StartRequest) GetFactoryOs ¶
func (x *StartRequest) GetFactoryOs() bool
func (*StartRequest) GetZeroFill ¶
func (x *StartRequest) GetZeroFill() bool
func (*StartRequest) ProtoMessage ¶
func (*StartRequest) ProtoMessage()
func (*StartRequest) ProtoReflect ¶
func (x *StartRequest) ProtoReflect() protoreflect.Message
func (*StartRequest) Reset ¶
func (x *StartRequest) Reset()
func (*StartRequest) String ¶
func (x *StartRequest) String() string
type StartResponse ¶
type StartResponse struct {
// Types that are assignable to Response:
// *StartResponse_ResetSuccess
// *StartResponse_ResetError
Response isStartResponse_Response `protobuf_oneof:"response"`
// contains filtered or unexported fields
}
func (*StartResponse) Descriptor
deprecated
func (*StartResponse) Descriptor() ([]byte, []int)
Deprecated: Use StartResponse.ProtoReflect.Descriptor instead.
func (*StartResponse) GetResetError ¶
func (x *StartResponse) GetResetError() *ResetError
func (*StartResponse) GetResetSuccess ¶
func (x *StartResponse) GetResetSuccess() *ResetSuccess
func (*StartResponse) GetResponse ¶
func (m *StartResponse) GetResponse() isStartResponse_Response
func (*StartResponse) ProtoMessage ¶
func (*StartResponse) ProtoMessage()
func (*StartResponse) ProtoReflect ¶
func (x *StartResponse) ProtoReflect() protoreflect.Message
func (*StartResponse) Reset ¶
func (x *StartResponse) Reset()
func (*StartResponse) String ¶
func (x *StartResponse) String() string
type StartResponse_ResetError ¶
type StartResponse_ResetError struct {
// Reset will not be executed.
ResetError *ResetError `protobuf:"bytes,2,opt,name=reset_error,json=resetError,proto3,oneof"`
}
type StartResponse_ResetSuccess ¶
type StartResponse_ResetSuccess struct {
// Reset will be executed.
ResetSuccess *ResetSuccess `protobuf:"bytes,1,opt,name=reset_success,json=resetSuccess,proto3,oneof"`
}
type UnimplementedFactoryResetServer ¶
type UnimplementedFactoryResetServer struct {
}
UnimplementedFactoryResetServer can be embedded to have forward compatible implementations.
func (*UnimplementedFactoryResetServer) Start ¶
func (*UnimplementedFactoryResetServer) Start(context.Context, *StartRequest) (*StartResponse, error)
Click to show internal directories.
Click to hide internal directories.