Documentation
¶
Overview ¶
Package com_seagate_kinetic_proto is a generated protocol buffer package.
* Copyright 2013-2015 Seagate Technology LLC.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MP:/2.0/.
This program is distributed in the hope that it will be useful, but is provided AS-IS, WITHOUT ANY WARRANTY; including without the implied warranty of MERCHANTABILITY, NON-INFRINGEMENT or FITNESS FOR A PARTICULAR PURPOSE. See the Mozilla Public License for more details.
See www.openkinetic.org for more project information ¶
It is generated from these files:
kinetic.proto
It has these top-level messages:
Local Message Command
Index ¶
- Constants
- Variables
- type Command
- type Command_Algorithm
- type Command_Batch
- type Command_Body
- func (*Command_Body) Descriptor() ([]byte, []int)
- func (m *Command_Body) GetBatch() *Command_Batch
- func (m *Command_Body) GetGetLog() *Command_GetLog
- func (m *Command_Body) GetKeyValue() *Command_KeyValue
- func (m *Command_Body) GetP2POperation() *Command_P2POperation
- func (m *Command_Body) GetPinOp() *Command_PinOperation
- func (m *Command_Body) GetPower() *Command_PowerManagement
- func (m *Command_Body) GetRange() *Command_Range
- func (m *Command_Body) GetSecurity() *Command_Security
- func (m *Command_Body) GetSetup() *Command_Setup
- func (*Command_Body) ProtoMessage()
- func (m *Command_Body) Reset()
- func (m *Command_Body) String() string
- type Command_GetLog
- func (*Command_GetLog) Descriptor() ([]byte, []int)
- func (m *Command_GetLog) GetCapacity() *Command_GetLog_Capacity
- func (m *Command_GetLog) GetConfiguration() *Command_GetLog_Configuration
- func (m *Command_GetLog) GetDevice() *Command_GetLog_Device
- func (m *Command_GetLog) GetLimits() *Command_GetLog_Limits
- func (m *Command_GetLog) GetMessages() []byte
- func (m *Command_GetLog) GetStatistics() []*Command_GetLog_Statistics
- func (m *Command_GetLog) GetTemperatures() []*Command_GetLog_Temperature
- func (m *Command_GetLog) GetTypes() []Command_GetLog_Type
- func (m *Command_GetLog) GetUtilizations() []*Command_GetLog_Utilization
- func (*Command_GetLog) ProtoMessage()
- func (m *Command_GetLog) Reset()
- func (m *Command_GetLog) String() string
- type Command_GetLog_Capacity
- func (*Command_GetLog_Capacity) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Capacity) GetNominalCapacityInBytes() uint64
- func (m *Command_GetLog_Capacity) GetPortionFull() float32
- func (*Command_GetLog_Capacity) ProtoMessage()
- func (m *Command_GetLog_Capacity) Reset()
- func (m *Command_GetLog_Capacity) String() string
- type Command_GetLog_Configuration
- func (*Command_GetLog_Configuration) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Configuration) GetCompilationDate() string
- func (m *Command_GetLog_Configuration) GetCurrentPowerLevel() Command_PowerLevel
- func (m *Command_GetLog_Configuration) GetInterface() []*Command_GetLog_Configuration_Interface
- func (m *Command_GetLog_Configuration) GetModel() string
- func (m *Command_GetLog_Configuration) GetPort() int32
- func (m *Command_GetLog_Configuration) GetProtocolCompilationDate() string
- func (m *Command_GetLog_Configuration) GetProtocolSourceHash() string
- func (m *Command_GetLog_Configuration) GetProtocolVersion() string
- func (m *Command_GetLog_Configuration) GetSerialNumber() []byte
- func (m *Command_GetLog_Configuration) GetSourceHash() string
- func (m *Command_GetLog_Configuration) GetTlsPort() int32
- func (m *Command_GetLog_Configuration) GetVendor() string
- func (m *Command_GetLog_Configuration) GetVersion() string
- func (m *Command_GetLog_Configuration) GetWorldWideName() []byte
- func (*Command_GetLog_Configuration) ProtoMessage()
- func (m *Command_GetLog_Configuration) Reset()
- func (m *Command_GetLog_Configuration) String() string
- type Command_GetLog_Configuration_Interface
- func (*Command_GetLog_Configuration_Interface) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Configuration_Interface) GetIpv4Address() []byte
- func (m *Command_GetLog_Configuration_Interface) GetIpv6Address() []byte
- func (m *Command_GetLog_Configuration_Interface) GetMAC() []byte
- func (m *Command_GetLog_Configuration_Interface) GetName() string
- func (*Command_GetLog_Configuration_Interface) ProtoMessage()
- func (m *Command_GetLog_Configuration_Interface) Reset()
- func (m *Command_GetLog_Configuration_Interface) String() string
- type Command_GetLog_Device
- type Command_GetLog_Limits
- func (*Command_GetLog_Limits) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Limits) GetMaxBatchCountPerDevice() uint32
- func (m *Command_GetLog_Limits) GetMaxConnections() uint32
- func (m *Command_GetLog_Limits) GetMaxIdentityCount() uint32
- func (m *Command_GetLog_Limits) GetMaxKeyRangeCount() uint32
- func (m *Command_GetLog_Limits) GetMaxKeySize() uint32
- func (m *Command_GetLog_Limits) GetMaxMessageSize() uint32
- func (m *Command_GetLog_Limits) GetMaxOperationCountPerBatch() uint32
- func (m *Command_GetLog_Limits) GetMaxOutstandingReadRequests() uint32
- func (m *Command_GetLog_Limits) GetMaxOutstandingWriteRequests() uint32
- func (m *Command_GetLog_Limits) GetMaxPinSize() uint32
- func (m *Command_GetLog_Limits) GetMaxTagSize() uint32
- func (m *Command_GetLog_Limits) GetMaxValueSize() uint32
- func (m *Command_GetLog_Limits) GetMaxVersionSize() uint32
- func (*Command_GetLog_Limits) ProtoMessage()
- func (m *Command_GetLog_Limits) Reset()
- func (m *Command_GetLog_Limits) String() string
- type Command_GetLog_Statistics
- func (*Command_GetLog_Statistics) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Statistics) GetBytes() uint64
- func (m *Command_GetLog_Statistics) GetCount() uint64
- func (m *Command_GetLog_Statistics) GetMessageType() Command_MessageType
- func (*Command_GetLog_Statistics) ProtoMessage()
- func (m *Command_GetLog_Statistics) Reset()
- func (m *Command_GetLog_Statistics) String() string
- type Command_GetLog_Temperature
- func (*Command_GetLog_Temperature) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Temperature) GetCurrent() float32
- func (m *Command_GetLog_Temperature) GetMaximum() float32
- func (m *Command_GetLog_Temperature) GetMinimum() float32
- func (m *Command_GetLog_Temperature) GetName() string
- func (m *Command_GetLog_Temperature) GetTarget() float32
- func (*Command_GetLog_Temperature) ProtoMessage()
- func (m *Command_GetLog_Temperature) Reset()
- func (m *Command_GetLog_Temperature) String() string
- type Command_GetLog_Type
- type Command_GetLog_Utilization
- func (*Command_GetLog_Utilization) Descriptor() ([]byte, []int)
- func (m *Command_GetLog_Utilization) GetName() string
- func (m *Command_GetLog_Utilization) GetValue() float32
- func (*Command_GetLog_Utilization) ProtoMessage()
- func (m *Command_GetLog_Utilization) Reset()
- func (m *Command_GetLog_Utilization) String() string
- type Command_Header
- func (*Command_Header) Descriptor() ([]byte, []int)
- func (m *Command_Header) GetAckSequence() int64
- func (m *Command_Header) GetBatchID() uint32
- func (m *Command_Header) GetClusterVersion() int64
- func (m *Command_Header) GetConnectionID() int64
- func (m *Command_Header) GetEarlyExit() bool
- func (m *Command_Header) GetMessageType() Command_MessageType
- func (m *Command_Header) GetPriority() Command_Priority
- func (m *Command_Header) GetSequence() int64
- func (m *Command_Header) GetTimeQuanta() int64
- func (m *Command_Header) GetTimeout() int64
- func (*Command_Header) ProtoMessage()
- func (m *Command_Header) Reset()
- func (m *Command_Header) String() string
- type Command_KeyValue
- func (*Command_KeyValue) Descriptor() ([]byte, []int)
- func (m *Command_KeyValue) GetAlgorithm() Command_Algorithm
- func (m *Command_KeyValue) GetDbVersion() []byte
- func (m *Command_KeyValue) GetForce() bool
- func (m *Command_KeyValue) GetKey() []byte
- func (m *Command_KeyValue) GetMetadataOnly() bool
- func (m *Command_KeyValue) GetNewVersion() []byte
- func (m *Command_KeyValue) GetSynchronization() Command_Synchronization
- func (m *Command_KeyValue) GetTag() []byte
- func (*Command_KeyValue) ProtoMessage()
- func (m *Command_KeyValue) Reset()
- func (m *Command_KeyValue) String() string
- type Command_MessageType
- type Command_P2POperation
- func (*Command_P2POperation) Descriptor() ([]byte, []int)
- func (m *Command_P2POperation) GetAllChildOperationsSucceeded() bool
- func (m *Command_P2POperation) GetOperation() []*Command_P2POperation_Operation
- func (m *Command_P2POperation) GetPeer() *Command_P2POperation_Peer
- func (*Command_P2POperation) ProtoMessage()
- func (m *Command_P2POperation) Reset()
- func (m *Command_P2POperation) String() string
- type Command_P2POperation_Operation
- func (*Command_P2POperation_Operation) Descriptor() ([]byte, []int)
- func (m *Command_P2POperation_Operation) GetForce() bool
- func (m *Command_P2POperation_Operation) GetKey() []byte
- func (m *Command_P2POperation_Operation) GetNewKey() []byte
- func (m *Command_P2POperation_Operation) GetP2Pop() *Command_P2POperation
- func (m *Command_P2POperation_Operation) GetStatus() *Command_Status
- func (m *Command_P2POperation_Operation) GetVersion() []byte
- func (*Command_P2POperation_Operation) ProtoMessage()
- func (m *Command_P2POperation_Operation) Reset()
- func (m *Command_P2POperation_Operation) String() string
- type Command_P2POperation_Peer
- func (*Command_P2POperation_Peer) Descriptor() ([]byte, []int)
- func (m *Command_P2POperation_Peer) GetHostname() string
- func (m *Command_P2POperation_Peer) GetPort() int32
- func (m *Command_P2POperation_Peer) GetTls() bool
- func (*Command_P2POperation_Peer) ProtoMessage()
- func (m *Command_P2POperation_Peer) Reset()
- func (m *Command_P2POperation_Peer) String() string
- type Command_PinOperation
- type Command_PinOperation_PinOpType
- type Command_PowerLevel
- type Command_PowerManagement
- type Command_Priority
- type Command_Range
- func (*Command_Range) Descriptor() ([]byte, []int)
- func (m *Command_Range) GetEndKey() []byte
- func (m *Command_Range) GetEndKeyInclusive() bool
- func (m *Command_Range) GetKeys() [][]byte
- func (m *Command_Range) GetMaxReturned() int32
- func (m *Command_Range) GetReverse() bool
- func (m *Command_Range) GetStartKey() []byte
- func (m *Command_Range) GetStartKeyInclusive() bool
- func (*Command_Range) ProtoMessage()
- func (m *Command_Range) Reset()
- func (m *Command_Range) String() string
- type Command_Security
- func (*Command_Security) Descriptor() ([]byte, []int)
- func (m *Command_Security) GetAcl() []*Command_Security_ACL
- func (m *Command_Security) GetNewErasePIN() []byte
- func (m *Command_Security) GetNewLockPIN() []byte
- func (m *Command_Security) GetOldErasePIN() []byte
- func (m *Command_Security) GetOldLockPIN() []byte
- func (*Command_Security) ProtoMessage()
- func (m *Command_Security) Reset()
- func (m *Command_Security) String() string
- type Command_Security_ACL
- func (*Command_Security_ACL) Descriptor() ([]byte, []int)
- func (m *Command_Security_ACL) GetHmacAlgorithm() Command_Security_ACL_HMACAlgorithm
- func (m *Command_Security_ACL) GetIdentity() int64
- func (m *Command_Security_ACL) GetKey() []byte
- func (m *Command_Security_ACL) GetMaxPriority() Command_Priority
- func (m *Command_Security_ACL) GetScope() []*Command_Security_ACL_Scope
- func (*Command_Security_ACL) ProtoMessage()
- func (m *Command_Security_ACL) Reset()
- func (m *Command_Security_ACL) String() string
- type Command_Security_ACL_HMACAlgorithm
- type Command_Security_ACL_Permission
- type Command_Security_ACL_Scope
- func (*Command_Security_ACL_Scope) Descriptor() ([]byte, []int)
- func (m *Command_Security_ACL_Scope) GetOffset() int64
- func (m *Command_Security_ACL_Scope) GetPermission() []Command_Security_ACL_Permission
- func (m *Command_Security_ACL_Scope) GetTlsRequired() bool
- func (m *Command_Security_ACL_Scope) GetValue() []byte
- func (*Command_Security_ACL_Scope) ProtoMessage()
- func (m *Command_Security_ACL_Scope) Reset()
- func (m *Command_Security_ACL_Scope) String() string
- type Command_Setup
- type Command_Status
- func (*Command_Status) Descriptor() ([]byte, []int)
- func (m *Command_Status) GetCode() Command_Status_StatusCode
- func (m *Command_Status) GetDetailedMessage() []byte
- func (m *Command_Status) GetStatusMessage() string
- func (*Command_Status) ProtoMessage()
- func (m *Command_Status) Reset()
- func (m *Command_Status) String() string
- type Command_Status_StatusCode
- type Command_Synchronization
- type Local
- type Message
- func (*Message) Descriptor() ([]byte, []int)
- func (m *Message) GetAuthType() Message_AuthType
- func (m *Message) GetCommandBytes() []byte
- func (m *Message) GetHmacAuth() *Message_HMACauth
- func (m *Message) GetPinAuth() *Message_PINauth
- func (*Message) ProtoMessage()
- func (m *Message) Reset()
- func (m *Message) String() string
- type Message_AuthType
- type Message_HMACauth
- type Message_PINauth
Constants ¶
const Default_Local_ProtocolVersion string = "3.1.0"
Variables ¶
var Command_Algorithm_name = map[int32]string{
-1: "INVALID_ALGORITHM",
1: "SHA1",
2: "SHA2",
3: "SHA3",
4: "CRC32C",
5: "CRC64",
6: "CRC32",
}
var Command_Algorithm_value = map[string]int32{
"INVALID_ALGORITHM": -1,
"SHA1": 1,
"SHA2": 2,
"SHA3": 3,
"CRC32C": 4,
"CRC64": 5,
"CRC32": 6,
}
var Command_GetLog_Type_name = map[int32]string{
-1: "INVALID_TYPE",
0: "UTILIZATIONS",
1: "TEMPERATURES",
2: "CAPACITIES",
3: "CONFIGURATION",
4: "STATISTICS",
5: "MESSAGES",
6: "LIMITS",
7: "DEVICE",
}
var Command_GetLog_Type_value = map[string]int32{
"INVALID_TYPE": -1,
"UTILIZATIONS": 0,
"TEMPERATURES": 1,
"CAPACITIES": 2,
"CONFIGURATION": 3,
"STATISTICS": 4,
"MESSAGES": 5,
"LIMITS": 6,
"DEVICE": 7,
}
var Command_MessageType_name = map[int32]string{
-1: "INVALID_MESSAGE_TYPE",
2: "GET",
1: "GET_RESPONSE",
4: "PUT",
3: "PUT_RESPONSE",
6: "DELETE",
5: "DELETE_RESPONSE",
8: "GETNEXT",
7: "GETNEXT_RESPONSE",
10: "GETPREVIOUS",
9: "GETPREVIOUS_RESPONSE",
12: "GETKEYRANGE",
11: "GETKEYRANGE_RESPONSE",
16: "GETVERSION",
15: "GETVERSION_RESPONSE",
22: "SETUP",
21: "SETUP_RESPONSE",
24: "GETLOG",
23: "GETLOG_RESPONSE",
26: "SECURITY",
25: "SECURITY_RESPONSE",
28: "PEER2PEERPUSH",
27: "PEER2PEERPUSH_RESPONSE",
30: "NOOP",
29: "NOOP_RESPONSE",
32: "FLUSHALLDATA",
31: "FLUSHALLDATA_RESPONSE",
36: "PINOP",
35: "PINOP_RESPONSE",
38: "MEDIASCAN",
37: "MEDIASCAN_RESPONSE",
40: "MEDIAOPTIMIZE",
39: "MEDIAOPTIMIZE_RESPONSE",
42: "START_BATCH",
41: "START_BATCH_RESPONSE",
44: "END_BATCH",
43: "END_BATCH_RESPONSE",
46: "ABORT_BATCH",
45: "ABORT_BATCH_RESPONSE",
48: "SET_POWER_LEVEL",
47: "SET_POWER_LEVEL_RESPONSE",
}
var Command_MessageType_value = map[string]int32{
"INVALID_MESSAGE_TYPE": -1,
"GET": 2,
"GET_RESPONSE": 1,
"PUT": 4,
"PUT_RESPONSE": 3,
"DELETE": 6,
"DELETE_RESPONSE": 5,
"GETNEXT": 8,
"GETNEXT_RESPONSE": 7,
"GETPREVIOUS": 10,
"GETPREVIOUS_RESPONSE": 9,
"GETKEYRANGE": 12,
"GETKEYRANGE_RESPONSE": 11,
"GETVERSION": 16,
"GETVERSION_RESPONSE": 15,
"SETUP": 22,
"SETUP_RESPONSE": 21,
"GETLOG": 24,
"GETLOG_RESPONSE": 23,
"SECURITY": 26,
"SECURITY_RESPONSE": 25,
"PEER2PEERPUSH": 28,
"PEER2PEERPUSH_RESPONSE": 27,
"NOOP": 30,
"NOOP_RESPONSE": 29,
"FLUSHALLDATA": 32,
"FLUSHALLDATA_RESPONSE": 31,
"PINOP": 36,
"PINOP_RESPONSE": 35,
"MEDIASCAN": 38,
"MEDIASCAN_RESPONSE": 37,
"MEDIAOPTIMIZE": 40,
"MEDIAOPTIMIZE_RESPONSE": 39,
"START_BATCH": 42,
"START_BATCH_RESPONSE": 41,
"END_BATCH": 44,
"END_BATCH_RESPONSE": 43,
"ABORT_BATCH": 46,
"ABORT_BATCH_RESPONSE": 45,
"SET_POWER_LEVEL": 48,
"SET_POWER_LEVEL_RESPONSE": 47,
}
var Command_PinOperation_PinOpType_name = map[int32]string{
-1: "INVALID_PINOP",
1: "UNLOCK_PINOP",
2: "LOCK_PINOP",
3: "ERASE_PINOP",
4: "SECURE_ERASE_PINOP",
}
var Command_PinOperation_PinOpType_value = map[string]int32{
"INVALID_PINOP": -1,
"UNLOCK_PINOP": 1,
"LOCK_PINOP": 2,
"ERASE_PINOP": 3,
"SECURE_ERASE_PINOP": 4,
}
var Command_PowerLevel_name = map[int32]string{
-1: "INVALID_LEVEL",
1: "OPERATIONAL",
2: "HIBERNATE",
3: "SHUTDOWN",
4: "FAIL",
}
var Command_PowerLevel_value = map[string]int32{
"INVALID_LEVEL": -1,
"OPERATIONAL": 1,
"HIBERNATE": 2,
"SHUTDOWN": 3,
"FAIL": 4,
}
var Command_Priority_name = map[int32]string{
5: "NORMAL",
1: "LOWEST",
3: "LOWER",
7: "HIGHER",
9: "HIGHEST",
}
var Command_Priority_value = map[string]int32{
"NORMAL": 5,
"LOWEST": 1,
"LOWER": 3,
"HIGHER": 7,
"HIGHEST": 9,
}
var Command_Security_ACL_HMACAlgorithm_name = map[int32]string{
-1: "INVALID_HMAC_ALGORITHM",
1: "HmacSHA1",
}
var Command_Security_ACL_HMACAlgorithm_value = map[string]int32{
"INVALID_HMAC_ALGORITHM": -1,
"HmacSHA1": 1,
}
var Command_Security_ACL_Permission_name = map[int32]string{
-1: "INVALID_PERMISSION",
0: "READ",
1: "WRITE",
2: "DELETE",
3: "RANGE",
4: "SETUP",
5: "P2POP",
7: "GETLOG",
8: "SECURITY",
9: "POWER_MANAGEMENT",
}
var Command_Security_ACL_Permission_value = map[string]int32{
"INVALID_PERMISSION": -1,
"READ": 0,
"WRITE": 1,
"DELETE": 2,
"RANGE": 3,
"SETUP": 4,
"P2POP": 5,
"GETLOG": 7,
"SECURITY": 8,
"POWER_MANAGEMENT": 9,
}
var Command_Status_StatusCode_name = map[int32]string{
-1: "INVALID_STATUS_CODE",
0: "NOT_ATTEMPTED",
1: "SUCCESS",
2: "HMAC_FAILURE",
3: "NOT_AUTHORIZED",
4: "VERSION_FAILURE",
5: "INTERNAL_ERROR",
6: "HEADER_REQUIRED",
7: "NOT_FOUND",
8: "VERSION_MISMATCH",
9: "SERVICE_BUSY",
10: "EXPIRED",
11: "DATA_ERROR",
12: "PERM_DATA_ERROR",
13: "REMOTE_CONNECTION_ERROR",
14: "NO_SPACE",
15: "NO_SUCH_HMAC_ALGORITHM",
16: "INVALID_REQUEST",
17: "NESTED_OPERATION_ERRORS",
18: "DEVICE_LOCKED",
19: "DEVICE_ALREADY_UNLOCKED",
20: "CONNECTION_TERMINATED",
21: "INVALID_BATCH",
22: "HIBERNATE",
23: "SHUTDOWN",
}
var Command_Status_StatusCode_value = map[string]int32{
"INVALID_STATUS_CODE": -1,
"NOT_ATTEMPTED": 0,
"SUCCESS": 1,
"HMAC_FAILURE": 2,
"NOT_AUTHORIZED": 3,
"VERSION_FAILURE": 4,
"INTERNAL_ERROR": 5,
"HEADER_REQUIRED": 6,
"NOT_FOUND": 7,
"VERSION_MISMATCH": 8,
"SERVICE_BUSY": 9,
"EXPIRED": 10,
"DATA_ERROR": 11,
"PERM_DATA_ERROR": 12,
"REMOTE_CONNECTION_ERROR": 13,
"NO_SPACE": 14,
"NO_SUCH_HMAC_ALGORITHM": 15,
"INVALID_REQUEST": 16,
"NESTED_OPERATION_ERRORS": 17,
"DEVICE_LOCKED": 18,
"DEVICE_ALREADY_UNLOCKED": 19,
"CONNECTION_TERMINATED": 20,
"INVALID_BATCH": 21,
"HIBERNATE": 22,
"SHUTDOWN": 23,
}
var Command_Synchronization_name = map[int32]string{
-1: "INVALID_SYNCHRONIZATION",
1: "WRITETHROUGH",
2: "WRITEBACK",
3: "FLUSH",
}
var Command_Synchronization_value = map[string]int32{
"INVALID_SYNCHRONIZATION": -1,
"WRITETHROUGH": 1,
"WRITEBACK": 2,
"FLUSH": 3,
}
var Message_AuthType_name = map[int32]string{
-1: "INVALID_AUTH_TYPE",
1: "HMACAUTH",
2: "PINAUTH",
3: "UNSOLICITEDSTATUS",
}
var Message_AuthType_value = map[string]int32{
"INVALID_AUTH_TYPE": -1,
"HMACAUTH": 1,
"PINAUTH": 2,
"UNSOLICITEDSTATUS": 3,
}
Functions ¶
This section is empty.
Types ¶
type Command ¶
type Command struct { // message header Header *Command_Header `protobuf:"bytes,1,opt,name=header" json:"header,omitempty"` // message body Body *Command_Body `protobuf:"bytes,2,opt,name=body" json:"body,omitempty"` // operation status Status *Command_Status `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command) Descriptor ¶
func (*Command) GetBody ¶
func (m *Command) GetBody() *Command_Body
func (*Command) GetHeader ¶
func (m *Command) GetHeader() *Command_Header
func (*Command) GetStatus ¶
func (m *Command) GetStatus() *Command_Status
func (*Command) ProtoMessage ¶
func (*Command) ProtoMessage()
type Command_Algorithm ¶
type Command_Algorithm int32
algorithm
const ( Command_INVALID_ALGORITHM Command_Algorithm = -1 Command_SHA1 Command_Algorithm = 1 Command_SHA2 Command_Algorithm = 2 Command_SHA3 Command_Algorithm = 3 Command_CRC32C Command_Algorithm = 4 Command_CRC64 Command_Algorithm = 5 Command_CRC32 Command_Algorithm = 6 )
func (Command_Algorithm) Enum ¶
func (x Command_Algorithm) Enum() *Command_Algorithm
func (Command_Algorithm) EnumDescriptor ¶
func (Command_Algorithm) EnumDescriptor() ([]byte, []int)
func (Command_Algorithm) String ¶
func (x Command_Algorithm) String() string
func (*Command_Algorithm) UnmarshalJSON ¶
func (x *Command_Algorithm) UnmarshalJSON(data []byte) error
type Command_Batch ¶
type Command_Batch struct { // set by the client library in END_BATCH request message. // the total number of operations in the batch Count *int32 `protobuf:"varint,1,opt,name=count" json:"count,omitempty"` // set by the drive in END_BATCH_RESPONSE message. // If a batch is committed successfully, all sequence Ids of those // commands (PUT/DELETE) performed in the batch are // added in the END_BATCH_RESPONSE message. Sequence []int64 `protobuf:"varint,2,rep,packed,name=sequence" json:"sequence,omitempty"` // This field is set by the drive if a batch commit failed. // The first failed operation sequence in the batch is set as value. FailedSequence *int64 `protobuf:"varint,3,opt,name=failedSequence" json:"failedSequence,omitempty"` XXX_unrecognized []byte `json:"-"` }
This is included in the END_BATCH and END_BATCH_RESPONSE.
func (*Command_Batch) Descriptor ¶
func (*Command_Batch) Descriptor() ([]byte, []int)
func (*Command_Batch) GetCount ¶
func (m *Command_Batch) GetCount() int32
func (*Command_Batch) GetFailedSequence ¶
func (m *Command_Batch) GetFailedSequence() int64
func (*Command_Batch) GetSequence ¶
func (m *Command_Batch) GetSequence() []int64
func (*Command_Batch) ProtoMessage ¶
func (*Command_Batch) ProtoMessage()
func (*Command_Batch) Reset ¶
func (m *Command_Batch) Reset()
func (*Command_Batch) String ¶
func (m *Command_Batch) String() string
type Command_Body ¶
type Command_Body struct { // key/value op KeyValue *Command_KeyValue `protobuf:"bytes,1,opt,name=keyValue" json:"keyValue,omitempty"` // range operation Range *Command_Range `protobuf:"bytes,2,opt,name=range" json:"range,omitempty"` // set up operation Setup *Command_Setup `protobuf:"bytes,3,opt,name=setup" json:"setup,omitempty"` // Peer to Peer operations. P2POperation *Command_P2POperation `protobuf:"bytes,4,opt,name=p2pOperation" json:"p2pOperation,omitempty"` // GetLog GetLog *Command_GetLog `protobuf:"bytes,6,opt,name=getLog" json:"getLog,omitempty"` // set up security Security *Command_Security `protobuf:"bytes,7,opt,name=security" json:"security,omitempty"` // Perform Pin-based operations PinOp *Command_PinOperation `protobuf:"bytes,8,opt,name=pinOp" json:"pinOp,omitempty"` // batch operation // This is included in the END_BATCH and END_BATCH_RESPONSE. Batch *Command_Batch `protobuf:"bytes,9,opt,name=batch" json:"batch,omitempty"` // power management Power *Command_PowerManagement `protobuf:"bytes,10,opt,name=power" json:"power,omitempty"` XXX_unrecognized []byte `json:"-"` }
message body
func (*Command_Body) Descriptor ¶
func (*Command_Body) Descriptor() ([]byte, []int)
func (*Command_Body) GetBatch ¶
func (m *Command_Body) GetBatch() *Command_Batch
func (*Command_Body) GetGetLog ¶
func (m *Command_Body) GetGetLog() *Command_GetLog
func (*Command_Body) GetKeyValue ¶
func (m *Command_Body) GetKeyValue() *Command_KeyValue
func (*Command_Body) GetP2POperation ¶
func (m *Command_Body) GetP2POperation() *Command_P2POperation
func (*Command_Body) GetPinOp ¶
func (m *Command_Body) GetPinOp() *Command_PinOperation
func (*Command_Body) GetPower ¶
func (m *Command_Body) GetPower() *Command_PowerManagement
func (*Command_Body) GetRange ¶
func (m *Command_Body) GetRange() *Command_Range
func (*Command_Body) GetSecurity ¶
func (m *Command_Body) GetSecurity() *Command_Security
func (*Command_Body) GetSetup ¶
func (m *Command_Body) GetSetup() *Command_Setup
func (*Command_Body) ProtoMessage ¶
func (*Command_Body) ProtoMessage()
func (*Command_Body) Reset ¶
func (m *Command_Body) Reset()
func (*Command_Body) String ¶
func (m *Command_Body) String() string
type Command_GetLog ¶
type Command_GetLog struct { Types []Command_GetLog_Type `protobuf:"varint,1,rep,name=types,enum=com.seagate.kinetic.proto.Command_GetLog_Type" json:"types,omitempty"` Utilizations []*Command_GetLog_Utilization `protobuf:"bytes,2,rep,name=utilizations" json:"utilizations,omitempty"` Temperatures []*Command_GetLog_Temperature `protobuf:"bytes,3,rep,name=temperatures" json:"temperatures,omitempty"` Capacity *Command_GetLog_Capacity `protobuf:"bytes,4,opt,name=capacity" json:"capacity,omitempty"` Configuration *Command_GetLog_Configuration `protobuf:"bytes,5,opt,name=configuration" json:"configuration,omitempty"` Statistics []*Command_GetLog_Statistics `protobuf:"bytes,6,rep,name=statistics" json:"statistics,omitempty"` Messages []byte `protobuf:"bytes,7,opt,name=messages" json:"messages,omitempty"` Limits *Command_GetLog_Limits `protobuf:"bytes,8,opt,name=limits" json:"limits,omitempty"` Device *Command_GetLog_Device `protobuf:"bytes,9,opt,name=device" json:"device,omitempty"` XXX_unrecognized []byte `json:"-"` }
get log
func (*Command_GetLog) Descriptor ¶
func (*Command_GetLog) Descriptor() ([]byte, []int)
func (*Command_GetLog) GetCapacity ¶
func (m *Command_GetLog) GetCapacity() *Command_GetLog_Capacity
func (*Command_GetLog) GetConfiguration ¶
func (m *Command_GetLog) GetConfiguration() *Command_GetLog_Configuration
func (*Command_GetLog) GetDevice ¶
func (m *Command_GetLog) GetDevice() *Command_GetLog_Device
func (*Command_GetLog) GetLimits ¶
func (m *Command_GetLog) GetLimits() *Command_GetLog_Limits
func (*Command_GetLog) GetMessages ¶
func (m *Command_GetLog) GetMessages() []byte
func (*Command_GetLog) GetStatistics ¶
func (m *Command_GetLog) GetStatistics() []*Command_GetLog_Statistics
func (*Command_GetLog) GetTemperatures ¶
func (m *Command_GetLog) GetTemperatures() []*Command_GetLog_Temperature
func (*Command_GetLog) GetTypes ¶
func (m *Command_GetLog) GetTypes() []Command_GetLog_Type
func (*Command_GetLog) GetUtilizations ¶
func (m *Command_GetLog) GetUtilizations() []*Command_GetLog_Utilization
func (*Command_GetLog) ProtoMessage ¶
func (*Command_GetLog) ProtoMessage()
func (*Command_GetLog) Reset ¶
func (m *Command_GetLog) Reset()
func (*Command_GetLog) String ¶
func (m *Command_GetLog) String() string
type Command_GetLog_Capacity ¶
type Command_GetLog_Capacity struct { // 1-3 are reserved NominalCapacityInBytes *uint64 `protobuf:"varint,4,opt,name=nominalCapacityInBytes" json:"nominalCapacityInBytes,omitempty"` PortionFull *float32 `protobuf:"fixed32,5,opt,name=portionFull" json:"portionFull,omitempty"` XXX_unrecognized []byte `json:"-"` }
These capacities are in bytes.
func (*Command_GetLog_Capacity) Descriptor ¶
func (*Command_GetLog_Capacity) Descriptor() ([]byte, []int)
func (*Command_GetLog_Capacity) GetNominalCapacityInBytes ¶
func (m *Command_GetLog_Capacity) GetNominalCapacityInBytes() uint64
func (*Command_GetLog_Capacity) GetPortionFull ¶
func (m *Command_GetLog_Capacity) GetPortionFull() float32
func (*Command_GetLog_Capacity) ProtoMessage ¶
func (*Command_GetLog_Capacity) ProtoMessage()
func (*Command_GetLog_Capacity) Reset ¶
func (m *Command_GetLog_Capacity) Reset()
func (*Command_GetLog_Capacity) String ¶
func (m *Command_GetLog_Capacity) String() string
type Command_GetLog_Configuration ¶
type Command_GetLog_Configuration struct { // name of the vendor. Should be "Seagate" Vendor *string `protobuf:"bytes,5,opt,name=vendor" json:"vendor,omitempty"` // The model of the device. // "Simulator" for the simulator. Model *string `protobuf:"bytes,6,opt,name=model" json:"model,omitempty"` // Device Serial number (SN) SerialNumber []byte `protobuf:"bytes,7,opt,name=serialNumber" json:"serialNumber,omitempty"` // Device world wide name (WWN) WorldWideName []byte `protobuf:"bytes,14,opt,name=worldWideName" json:"worldWideName,omitempty"` // This is the vendor specific version of the software on the device in dot notation // if this is not set or ends with "x" this is test code. Version *string `protobuf:"bytes,8,opt,name=version" json:"version,omitempty"` CompilationDate *string `protobuf:"bytes,12,opt,name=compilationDate" json:"compilationDate,omitempty"` SourceHash *string `protobuf:"bytes,13,opt,name=sourceHash" json:"sourceHash,omitempty"` // This is the version of the protocol (.proto file) that the device uses. // This is not the highest or lowest version that is supported, just // the version that was compiled. ProtocolVersion *string `protobuf:"bytes,15,opt,name=protocolVersion" json:"protocolVersion,omitempty"` ProtocolCompilationDate *string `protobuf:"bytes,16,opt,name=protocolCompilationDate" json:"protocolCompilationDate,omitempty"` ProtocolSourceHash *string `protobuf:"bytes,17,opt,name=protocolSourceHash" json:"protocolSourceHash,omitempty"` // the interfaces for this device. one per interface. Interface []*Command_GetLog_Configuration_Interface `protobuf:"bytes,9,rep,name=interface" json:"interface,omitempty"` // these are the port numbers for the software Port *int32 `protobuf:"varint,10,opt,name=port" json:"port,omitempty"` TlsPort *int32 `protobuf:"varint,11,opt,name=tlsPort" json:"tlsPort,omitempty"` // The unsolicited message at the beginning of a connection will return // the drive status. The only two possible values are OPERATIONAL // or HIBERNATE. CurrentPowerLevel *Command_PowerLevel `` /* 132-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
func (*Command_GetLog_Configuration) Descriptor ¶
func (*Command_GetLog_Configuration) Descriptor() ([]byte, []int)
func (*Command_GetLog_Configuration) GetCompilationDate ¶
func (m *Command_GetLog_Configuration) GetCompilationDate() string
func (*Command_GetLog_Configuration) GetCurrentPowerLevel ¶
func (m *Command_GetLog_Configuration) GetCurrentPowerLevel() Command_PowerLevel
func (*Command_GetLog_Configuration) GetInterface ¶
func (m *Command_GetLog_Configuration) GetInterface() []*Command_GetLog_Configuration_Interface
func (*Command_GetLog_Configuration) GetModel ¶
func (m *Command_GetLog_Configuration) GetModel() string
func (*Command_GetLog_Configuration) GetPort ¶
func (m *Command_GetLog_Configuration) GetPort() int32
func (*Command_GetLog_Configuration) GetProtocolCompilationDate ¶
func (m *Command_GetLog_Configuration) GetProtocolCompilationDate() string
func (*Command_GetLog_Configuration) GetProtocolSourceHash ¶
func (m *Command_GetLog_Configuration) GetProtocolSourceHash() string
func (*Command_GetLog_Configuration) GetProtocolVersion ¶
func (m *Command_GetLog_Configuration) GetProtocolVersion() string
func (*Command_GetLog_Configuration) GetSerialNumber ¶
func (m *Command_GetLog_Configuration) GetSerialNumber() []byte
func (*Command_GetLog_Configuration) GetSourceHash ¶
func (m *Command_GetLog_Configuration) GetSourceHash() string
func (*Command_GetLog_Configuration) GetTlsPort ¶
func (m *Command_GetLog_Configuration) GetTlsPort() int32
func (*Command_GetLog_Configuration) GetVendor ¶
func (m *Command_GetLog_Configuration) GetVendor() string
func (*Command_GetLog_Configuration) GetVersion ¶
func (m *Command_GetLog_Configuration) GetVersion() string
func (*Command_GetLog_Configuration) GetWorldWideName ¶
func (m *Command_GetLog_Configuration) GetWorldWideName() []byte
func (*Command_GetLog_Configuration) ProtoMessage ¶
func (*Command_GetLog_Configuration) ProtoMessage()
func (*Command_GetLog_Configuration) Reset ¶
func (m *Command_GetLog_Configuration) Reset()
func (*Command_GetLog_Configuration) String ¶
func (m *Command_GetLog_Configuration) String() string
type Command_GetLog_Configuration_Interface ¶
type Command_GetLog_Configuration_Interface struct { Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` MAC []byte `protobuf:"bytes,2,opt,name=MAC" json:"MAC,omitempty"` Ipv4Address []byte `protobuf:"bytes,3,opt,name=ipv4Address" json:"ipv4Address,omitempty"` Ipv6Address []byte `protobuf:"bytes,4,opt,name=ipv6Address" json:"ipv6Address,omitempty"` XXX_unrecognized []byte `json:"-"` }
18, 19 are reserved.
func (*Command_GetLog_Configuration_Interface) Descriptor ¶
func (*Command_GetLog_Configuration_Interface) Descriptor() ([]byte, []int)
func (*Command_GetLog_Configuration_Interface) GetIpv4Address ¶
func (m *Command_GetLog_Configuration_Interface) GetIpv4Address() []byte
func (*Command_GetLog_Configuration_Interface) GetIpv6Address ¶
func (m *Command_GetLog_Configuration_Interface) GetIpv6Address() []byte
func (*Command_GetLog_Configuration_Interface) GetMAC ¶
func (m *Command_GetLog_Configuration_Interface) GetMAC() []byte
func (*Command_GetLog_Configuration_Interface) GetName ¶
func (m *Command_GetLog_Configuration_Interface) GetName() string
func (*Command_GetLog_Configuration_Interface) ProtoMessage ¶
func (*Command_GetLog_Configuration_Interface) ProtoMessage()
func (*Command_GetLog_Configuration_Interface) Reset ¶
func (m *Command_GetLog_Configuration_Interface) Reset()
func (*Command_GetLog_Configuration_Interface) String ¶
func (m *Command_GetLog_Configuration_Interface) String() string
type Command_GetLog_Device ¶
type Command_GetLog_Device struct { Name []byte `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` XXX_unrecognized []byte `json:"-"` }
The Device GetLog message is to ask the device to send back the log of a certain name in the value field. The limit of each log is 1m byte.
Proprietary names should be prefaced by the vendor name so that name collisions do not happen in the future. An example could be names that start with “com.WD” would be for Western Digital devices.
If the name is not found, the get log returns NOT_FOUND.
There can be only one Device in the list of logs that can be retrieved.!
func (*Command_GetLog_Device) Descriptor ¶
func (*Command_GetLog_Device) Descriptor() ([]byte, []int)
func (*Command_GetLog_Device) GetName ¶
func (m *Command_GetLog_Device) GetName() []byte
func (*Command_GetLog_Device) ProtoMessage ¶
func (*Command_GetLog_Device) ProtoMessage()
func (*Command_GetLog_Device) Reset ¶
func (m *Command_GetLog_Device) Reset()
func (*Command_GetLog_Device) String ¶
func (m *Command_GetLog_Device) String() string
type Command_GetLog_Limits ¶
type Command_GetLog_Limits struct { MaxKeySize *uint32 `protobuf:"varint,1,opt,name=maxKeySize" json:"maxKeySize,omitempty"` MaxValueSize *uint32 `protobuf:"varint,2,opt,name=maxValueSize" json:"maxValueSize,omitempty"` MaxVersionSize *uint32 `protobuf:"varint,3,opt,name=maxVersionSize" json:"maxVersionSize,omitempty"` MaxTagSize *uint32 `protobuf:"varint,4,opt,name=maxTagSize" json:"maxTagSize,omitempty"` MaxConnections *uint32 `protobuf:"varint,5,opt,name=maxConnections" json:"maxConnections,omitempty"` MaxOutstandingReadRequests *uint32 `protobuf:"varint,6,opt,name=maxOutstandingReadRequests" json:"maxOutstandingReadRequests,omitempty"` MaxOutstandingWriteRequests *uint32 `protobuf:"varint,7,opt,name=maxOutstandingWriteRequests" json:"maxOutstandingWriteRequests,omitempty"` MaxMessageSize *uint32 `protobuf:"varint,8,opt,name=maxMessageSize" json:"maxMessageSize,omitempty"` MaxKeyRangeCount *uint32 `protobuf:"varint,9,opt,name=maxKeyRangeCount" json:"maxKeyRangeCount,omitempty"` MaxIdentityCount *uint32 `protobuf:"varint,10,opt,name=maxIdentityCount" json:"maxIdentityCount,omitempty"` MaxPinSize *uint32 `protobuf:"varint,11,opt,name=maxPinSize" json:"maxPinSize,omitempty"` MaxOperationCountPerBatch *uint32 `protobuf:"varint,12,opt,name=maxOperationCountPerBatch" json:"maxOperationCountPerBatch,omitempty"` MaxBatchCountPerDevice *uint32 `protobuf:"varint,13,opt,name=maxBatchCountPerDevice" json:"maxBatchCountPerDevice,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_GetLog_Limits) Descriptor ¶
func (*Command_GetLog_Limits) Descriptor() ([]byte, []int)
func (*Command_GetLog_Limits) GetMaxBatchCountPerDevice ¶
func (m *Command_GetLog_Limits) GetMaxBatchCountPerDevice() uint32
func (*Command_GetLog_Limits) GetMaxConnections ¶
func (m *Command_GetLog_Limits) GetMaxConnections() uint32
func (*Command_GetLog_Limits) GetMaxIdentityCount ¶
func (m *Command_GetLog_Limits) GetMaxIdentityCount() uint32
func (*Command_GetLog_Limits) GetMaxKeyRangeCount ¶
func (m *Command_GetLog_Limits) GetMaxKeyRangeCount() uint32
func (*Command_GetLog_Limits) GetMaxKeySize ¶
func (m *Command_GetLog_Limits) GetMaxKeySize() uint32
func (*Command_GetLog_Limits) GetMaxMessageSize ¶
func (m *Command_GetLog_Limits) GetMaxMessageSize() uint32
func (*Command_GetLog_Limits) GetMaxOperationCountPerBatch ¶
func (m *Command_GetLog_Limits) GetMaxOperationCountPerBatch() uint32
func (*Command_GetLog_Limits) GetMaxOutstandingReadRequests ¶
func (m *Command_GetLog_Limits) GetMaxOutstandingReadRequests() uint32
func (*Command_GetLog_Limits) GetMaxOutstandingWriteRequests ¶
func (m *Command_GetLog_Limits) GetMaxOutstandingWriteRequests() uint32
func (*Command_GetLog_Limits) GetMaxPinSize ¶
func (m *Command_GetLog_Limits) GetMaxPinSize() uint32
func (*Command_GetLog_Limits) GetMaxTagSize ¶
func (m *Command_GetLog_Limits) GetMaxTagSize() uint32
func (*Command_GetLog_Limits) GetMaxValueSize ¶
func (m *Command_GetLog_Limits) GetMaxValueSize() uint32
func (*Command_GetLog_Limits) GetMaxVersionSize ¶
func (m *Command_GetLog_Limits) GetMaxVersionSize() uint32
func (*Command_GetLog_Limits) ProtoMessage ¶
func (*Command_GetLog_Limits) ProtoMessage()
func (*Command_GetLog_Limits) Reset ¶
func (m *Command_GetLog_Limits) Reset()
func (*Command_GetLog_Limits) String ¶
func (m *Command_GetLog_Limits) String() string
type Command_GetLog_Statistics ¶
type Command_GetLog_Statistics struct { MessageType *Command_MessageType `protobuf:"varint,1,opt,name=messageType,enum=com.seagate.kinetic.proto.Command_MessageType" json:"messageType,omitempty"` // 2 and 3 are reserved, do not use Count *uint64 `protobuf:"varint,4,opt,name=count" json:"count,omitempty"` // This is the sum of the data that is in the data portion. This does not include t // the command description. For P2P operations, this is the amount of data moved between // devices Bytes *uint64 `protobuf:"varint,5,opt,name=bytes" json:"bytes,omitempty"` XXX_unrecognized []byte `json:"-"` }
These numbers start at 0 when the device starts up and never wraps or resets.
func (*Command_GetLog_Statistics) Descriptor ¶
func (*Command_GetLog_Statistics) Descriptor() ([]byte, []int)
func (*Command_GetLog_Statistics) GetBytes ¶
func (m *Command_GetLog_Statistics) GetBytes() uint64
func (*Command_GetLog_Statistics) GetCount ¶
func (m *Command_GetLog_Statistics) GetCount() uint64
func (*Command_GetLog_Statistics) GetMessageType ¶
func (m *Command_GetLog_Statistics) GetMessageType() Command_MessageType
func (*Command_GetLog_Statistics) ProtoMessage ¶
func (*Command_GetLog_Statistics) ProtoMessage()
func (*Command_GetLog_Statistics) Reset ¶
func (m *Command_GetLog_Statistics) Reset()
func (*Command_GetLog_Statistics) String ¶
func (m *Command_GetLog_Statistics) String() string
type Command_GetLog_Temperature ¶
type Command_GetLog_Temperature struct { // The name of the temperature being reported. These names can be standard and proprietary. The // standard name is "HDA". If there are more items that are // being reported, such as processor temperature, can have a descriptive name. Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The current temperature in degrees c Current *float32 `protobuf:"fixed32,2,opt,name=current" json:"current,omitempty"` Minimum *float32 `protobuf:"fixed32,3,opt,name=minimum" json:"minimum,omitempty"` Maximum *float32 `protobuf:"fixed32,4,opt,name=maximum" json:"maximum,omitempty"` Target *float32 `protobuf:"fixed32,5,opt,name=target" json:"target,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_GetLog_Temperature) Descriptor ¶
func (*Command_GetLog_Temperature) Descriptor() ([]byte, []int)
func (*Command_GetLog_Temperature) GetCurrent ¶
func (m *Command_GetLog_Temperature) GetCurrent() float32
func (*Command_GetLog_Temperature) GetMaximum ¶
func (m *Command_GetLog_Temperature) GetMaximum() float32
func (*Command_GetLog_Temperature) GetMinimum ¶
func (m *Command_GetLog_Temperature) GetMinimum() float32
func (*Command_GetLog_Temperature) GetName ¶
func (m *Command_GetLog_Temperature) GetName() string
func (*Command_GetLog_Temperature) GetTarget ¶
func (m *Command_GetLog_Temperature) GetTarget() float32
func (*Command_GetLog_Temperature) ProtoMessage ¶
func (*Command_GetLog_Temperature) ProtoMessage()
func (*Command_GetLog_Temperature) Reset ¶
func (m *Command_GetLog_Temperature) Reset()
func (*Command_GetLog_Temperature) String ¶
func (m *Command_GetLog_Temperature) String() string
type Command_GetLog_Type ¶
type Command_GetLog_Type int32
const ( Command_GetLog_INVALID_TYPE Command_GetLog_Type = -1 Command_GetLog_UTILIZATIONS Command_GetLog_Type = 0 Command_GetLog_TEMPERATURES Command_GetLog_Type = 1 Command_GetLog_CAPACITIES Command_GetLog_Type = 2 Command_GetLog_CONFIGURATION Command_GetLog_Type = 3 Command_GetLog_STATISTICS Command_GetLog_Type = 4 Command_GetLog_MESSAGES Command_GetLog_Type = 5 Command_GetLog_LIMITS Command_GetLog_Type = 6 Command_GetLog_DEVICE Command_GetLog_Type = 7 )
func (Command_GetLog_Type) Enum ¶
func (x Command_GetLog_Type) Enum() *Command_GetLog_Type
func (Command_GetLog_Type) EnumDescriptor ¶
func (Command_GetLog_Type) EnumDescriptor() ([]byte, []int)
func (Command_GetLog_Type) String ¶
func (x Command_GetLog_Type) String() string
func (*Command_GetLog_Type) UnmarshalJSON ¶
func (x *Command_GetLog_Type) UnmarshalJSON(data []byte) error
type Command_GetLog_Utilization ¶
type Command_GetLog_Utilization struct { // The name of the utilization being reported. These names can be standard and proprietary. The // standard names are "HDA", "EN0" and "EN1". If there are more items that are // being reported, such as processor utilization, can have a descriptive name. Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // A number between 0.00 and 1.00. The resolution of this number is up to the // device. 1 means 100% utilized. Value *float32 `protobuf:"fixed32,2,opt,name=value" json:"value,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_GetLog_Utilization) Descriptor ¶
func (*Command_GetLog_Utilization) Descriptor() ([]byte, []int)
func (*Command_GetLog_Utilization) GetName ¶
func (m *Command_GetLog_Utilization) GetName() string
func (*Command_GetLog_Utilization) GetValue ¶
func (m *Command_GetLog_Utilization) GetValue() float32
func (*Command_GetLog_Utilization) ProtoMessage ¶
func (*Command_GetLog_Utilization) ProtoMessage()
func (*Command_GetLog_Utilization) Reset ¶
func (m *Command_GetLog_Utilization) Reset()
func (*Command_GetLog_Utilization) String ¶
func (m *Command_GetLog_Utilization) String() string
type Command_Header ¶
type Command_Header struct { // "cluster" is the number of the cluster definition. If this is incompatible, // the request is rejected. If it is missing, it is assumed to be 0. (0 allows systems not // using cluster versioning to ignore this field in the header and in the setup.) ClusterVersion *int64 `protobuf:"varint,1,opt,name=clusterVersion" json:"clusterVersion,omitempty"` // A unique number for this connection between the source and target. On the first request // to the device, this should be the time of day in seconds since 1970. The device can change this // number and the client must continue to use the new number and the number must remain // constant during the session. (See security document). ConnectionID *int64 `protobuf:"varint,3,opt,name=connectionID" json:"connectionID,omitempty"` // the sequence of this request in this TCP connection. As long as this value is getting larger we have // strong ordering and replay prevention within a session. This combined with the time and connectionID // provides strong ordering between sessions. (See security document). Sequence *int64 `protobuf:"varint,4,opt,name=sequence" json:"sequence,omitempty"` // co-related sequence AckSequence *int64 `protobuf:"varint,6,opt,name=ackSequence" json:"ackSequence,omitempty"` // operation code - put/get/delete/GetLog, etc. MessageType *Command_MessageType `protobuf:"varint,7,opt,name=messageType,enum=com.seagate.kinetic.proto.Command_MessageType" json:"messageType,omitempty"` // Request timeout (in ms). This is the amount of time that this request should take. If this timeout // is triggered, there are three possible results that can be returned. // - SERVICE_BUSY meaning that the request was still on the queue waiting to be executed // - EXPIRED meaning that a long running operation was stopped because the time expired. // - DATA_ERROR meaning that the request was in process, but that the error recovery was not // complete at the time that the time expired Timeout *int64 `protobuf:"varint,9,opt,name=timeout" json:"timeout,omitempty"` // If true, requests will not attempt multi revolution recoveries even if the timeout has not occurred. // In this case the result will be DATA_ERROR. To have the device exhaust all possible error recovery, leave // this field off or set to false, and make sure that the timeout is set to be longer than any possible queue // time and error recovery time. On a disk device, the maximum error recovery time could be seconds. // Once all possible data recovery operations are complete and have not succeeded, PERM_DATA_ERROR will be // returned. EarlyExit *bool `protobuf:"varint,10,opt,name=earlyExit" json:"earlyExit,omitempty"` // Priority is a simple integer that determines the priority of this // request. All activity at a higher priority will execute before that // of lower priority traffic. A higher number is higher priority. Priority *Command_Priority `protobuf:"varint,12,opt,name=priority,enum=com.seagate.kinetic.proto.Command_Priority" json:"priority,omitempty"` // A hint of how long a job should run before yielding. Specified in // miliseconds. A value of 0 indicates that the operation can perform one // sub operation and then check to see if there are other sub higher // priority operations. An example of a sub-operation might be a single put // in a P2P operation, etc. TimeQuanta *int64 `protobuf:"varint,13,opt,name=TimeQuanta" json:"TimeQuanta,omitempty"` // batch id to be included in each command of a batch operation // this id is generated by client library and must be unique // within the same connection. BatchID *uint32 `protobuf:"varint,14,opt,name=batchID" json:"batchID,omitempty"` XXX_unrecognized []byte `json:"-"` }
message header
func (*Command_Header) Descriptor ¶
func (*Command_Header) Descriptor() ([]byte, []int)
func (*Command_Header) GetAckSequence ¶
func (m *Command_Header) GetAckSequence() int64
func (*Command_Header) GetBatchID ¶
func (m *Command_Header) GetBatchID() uint32
func (*Command_Header) GetClusterVersion ¶
func (m *Command_Header) GetClusterVersion() int64
func (*Command_Header) GetConnectionID ¶
func (m *Command_Header) GetConnectionID() int64
func (*Command_Header) GetEarlyExit ¶
func (m *Command_Header) GetEarlyExit() bool
func (*Command_Header) GetMessageType ¶
func (m *Command_Header) GetMessageType() Command_MessageType
func (*Command_Header) GetPriority ¶
func (m *Command_Header) GetPriority() Command_Priority
func (*Command_Header) GetSequence ¶
func (m *Command_Header) GetSequence() int64
func (*Command_Header) GetTimeQuanta ¶
func (m *Command_Header) GetTimeQuanta() int64
func (*Command_Header) GetTimeout ¶
func (m *Command_Header) GetTimeout() int64
func (*Command_Header) ProtoMessage ¶
func (*Command_Header) ProtoMessage()
func (*Command_Header) Reset ¶
func (m *Command_Header) Reset()
func (*Command_Header) String ¶
func (m *Command_Header) String() string
type Command_KeyValue ¶
type Command_KeyValue struct { // On a put or delete, this is the next version that the data will be. The version field is opaque to the // target. (See Atomic operations document) NewVersion []byte `protobuf:"bytes,2,opt,name=newVersion" json:"newVersion,omitempty"` // On a put or delete, this forces the write to ignore the existing version of existing data (if it exists). Force *bool `protobuf:"varint,8,opt,name=force" json:"force,omitempty"` // entry key Key []byte `protobuf:"bytes,3,opt,name=key" json:"key,omitempty"` // entry version in store DbVersion []byte `protobuf:"bytes,4,opt,name=dbVersion" json:"dbVersion,omitempty"` // this is the integrity value of the data. This may or may not be in the clear, depending on the algorithm // used. Tag []byte `protobuf:"bytes,5,opt,name=tag" json:"tag,omitempty"` // The following is for the protection of the data. If the data is protected with a hash or CRC, then // the algorithm will be negative. If the data protection algorithm is not a standard unkeyed algorithm // then a positive number is used and the device has no idea what the key is. See the discussion of // encrypted key/value store.(See security document). Algorithm *Command_Algorithm `protobuf:"varint,6,opt,name=algorithm,enum=com.seagate.kinetic.proto.Command_Algorithm" json:"algorithm,omitempty"` // for read operations, this will get all the information about the value except for the // value itself. This is valuable for getting the integrity field or the version without also // having to get the data. If this field is not present, it is as if it is false. For // write or delete operations, if this is set, the command is rejected. MetadataOnly *bool `protobuf:"varint,7,opt,name=metadataOnly" json:"metadataOnly,omitempty"` // Synchronization allows the puts and deletes to determine if they are to be // WRITETHROUGH: This request is made persistent before returning. This does not effect any other pending operations. // WRITEBACK: They can be made persistent when the device chooses, or when a subsequent FLUSH is give to the device. // FLUSH: All pending information that has not been written is pushed to the disk and the command that // specifies FLUSH is written last and then returned. All WRITEBACK writes that have received ending // status will be guaranteed to be written before the FLUSH operation is returned completed. Synchronization *Command_Synchronization `` /* 132-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
key/value entry operation
func (*Command_KeyValue) Descriptor ¶
func (*Command_KeyValue) Descriptor() ([]byte, []int)
func (*Command_KeyValue) GetAlgorithm ¶
func (m *Command_KeyValue) GetAlgorithm() Command_Algorithm
func (*Command_KeyValue) GetDbVersion ¶
func (m *Command_KeyValue) GetDbVersion() []byte
func (*Command_KeyValue) GetForce ¶
func (m *Command_KeyValue) GetForce() bool
func (*Command_KeyValue) GetKey ¶
func (m *Command_KeyValue) GetKey() []byte
func (*Command_KeyValue) GetMetadataOnly ¶
func (m *Command_KeyValue) GetMetadataOnly() bool
func (*Command_KeyValue) GetNewVersion ¶
func (m *Command_KeyValue) GetNewVersion() []byte
func (*Command_KeyValue) GetSynchronization ¶
func (m *Command_KeyValue) GetSynchronization() Command_Synchronization
func (*Command_KeyValue) GetTag ¶
func (m *Command_KeyValue) GetTag() []byte
func (*Command_KeyValue) ProtoMessage ¶
func (*Command_KeyValue) ProtoMessage()
func (*Command_KeyValue) Reset ¶
func (m *Command_KeyValue) Reset()
func (*Command_KeyValue) String ¶
func (m *Command_KeyValue) String() string
type Command_MessageType ¶
type Command_MessageType int32
operation code
const ( Command_INVALID_MESSAGE_TYPE Command_MessageType = -1 Command_GET Command_MessageType = 2 Command_GET_RESPONSE Command_MessageType = 1 Command_PUT Command_MessageType = 4 Command_PUT_RESPONSE Command_MessageType = 3 Command_DELETE Command_MessageType = 6 Command_DELETE_RESPONSE Command_MessageType = 5 Command_GETNEXT Command_MessageType = 8 Command_GETNEXT_RESPONSE Command_MessageType = 7 Command_GETPREVIOUS Command_MessageType = 10 Command_GETPREVIOUS_RESPONSE Command_MessageType = 9 Command_GETKEYRANGE Command_MessageType = 12 Command_GETKEYRANGE_RESPONSE Command_MessageType = 11 // 13 and 14 are reserved, do not use Command_GETVERSION Command_MessageType = 16 Command_GETVERSION_RESPONSE Command_MessageType = 15 // 17, 18, 19, and 20 are reserved, do not use Command_SETUP Command_MessageType = 22 Command_SETUP_RESPONSE Command_MessageType = 21 Command_GETLOG Command_MessageType = 24 Command_GETLOG_RESPONSE Command_MessageType = 23 Command_SECURITY Command_MessageType = 26 Command_SECURITY_RESPONSE Command_MessageType = 25 Command_PEER2PEERPUSH Command_MessageType = 28 Command_PEER2PEERPUSH_RESPONSE Command_MessageType = 27 Command_NOOP Command_MessageType = 30 Command_NOOP_RESPONSE Command_MessageType = 29 Command_FLUSHALLDATA Command_MessageType = 32 Command_FLUSHALLDATA_RESPONSE Command_MessageType = 31 // 33, 34 are reserved Command_PINOP Command_MessageType = 36 Command_PINOP_RESPONSE Command_MessageType = 35 // Media scan is to check that the user data is readable, and // if the end to end integrity is known to the device, if the // end to end integrity field is correct. Command_MEDIASCAN Command_MessageType = 38 Command_MEDIASCAN_RESPONSE Command_MessageType = 37 // This performs optimizations of the media. Things like // defragmentation, compaction, garbage collection, compression // could be things accomplished using the media optimize command. Command_MEDIAOPTIMIZE Command_MessageType = 40 Command_MEDIAOPTIMIZE_RESPONSE Command_MessageType = 39 // batch operations Command_START_BATCH Command_MessageType = 42 Command_START_BATCH_RESPONSE Command_MessageType = 41 Command_END_BATCH Command_MessageType = 44 Command_END_BATCH_RESPONSE Command_MessageType = 43 Command_ABORT_BATCH Command_MessageType = 46 Command_ABORT_BATCH_RESPONSE Command_MessageType = 45 // power management Command_SET_POWER_LEVEL Command_MessageType = 48 Command_SET_POWER_LEVEL_RESPONSE Command_MessageType = 47 )
func (Command_MessageType) Enum ¶
func (x Command_MessageType) Enum() *Command_MessageType
func (Command_MessageType) EnumDescriptor ¶
func (Command_MessageType) EnumDescriptor() ([]byte, []int)
func (Command_MessageType) String ¶
func (x Command_MessageType) String() string
func (*Command_MessageType) UnmarshalJSON ¶
func (x *Command_MessageType) UnmarshalJSON(data []byte) error
type Command_P2POperation ¶
type Command_P2POperation struct { // Describe the target machine Peer *Command_P2POperation_Peer `protobuf:"bytes,1,opt,name=peer" json:"peer,omitempty"` // List of operations to be performed. Operation []*Command_P2POperation_Operation `protobuf:"bytes,2,rep,name=operation" json:"operation,omitempty"` // Indicates whether all operations have Status SUCCESS // When false, clients should traverse Operation status codes to discover // error cases. // When true, no further error checking should be required. AllChildOperationsSucceeded *bool `protobuf:"varint,3,opt,name=allChildOperationsSucceeded" json:"allChildOperationsSucceeded,omitempty"` XXX_unrecognized []byte `json:"-"` }
P2P operations allow devices to be able to send keys to other devices. this is either a standalone command or added to a put command.
func (*Command_P2POperation) Descriptor ¶
func (*Command_P2POperation) Descriptor() ([]byte, []int)
func (*Command_P2POperation) GetAllChildOperationsSucceeded ¶
func (m *Command_P2POperation) GetAllChildOperationsSucceeded() bool
func (*Command_P2POperation) GetOperation ¶
func (m *Command_P2POperation) GetOperation() []*Command_P2POperation_Operation
func (*Command_P2POperation) GetPeer ¶
func (m *Command_P2POperation) GetPeer() *Command_P2POperation_Peer
func (*Command_P2POperation) ProtoMessage ¶
func (*Command_P2POperation) ProtoMessage()
func (*Command_P2POperation) Reset ¶
func (m *Command_P2POperation) Reset()
func (*Command_P2POperation) String ¶
func (m *Command_P2POperation) String() string
type Command_P2POperation_Operation ¶
type Command_P2POperation_Operation struct { // the key of the entry to move Key []byte `protobuf:"bytes,3,opt,name=key" json:"key,omitempty"` // the expected version number in the other machine // the version number will be the version in the stored entry. Version []byte `protobuf:"bytes,4,opt,name=version" json:"version,omitempty"` // to have the moved key have a different final key used. NewKey []byte `protobuf:"bytes,5,opt,name=newKey" json:"newKey,omitempty"` // force the write ignoring the current key version. Force *bool `protobuf:"varint,6,opt,name=force" json:"force,omitempty"` // returned status Status *Command_Status `protobuf:"bytes,7,opt,name=status" json:"status,omitempty"` // an operation to add to this put operation. THis allows the // formation of a pipeline client -> A ->B ->C with the status for all returning // back to the client. P2Pop *Command_P2POperation `protobuf:"bytes,8,opt,name=p2pop" json:"p2pop,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_P2POperation_Operation) Descriptor ¶
func (*Command_P2POperation_Operation) Descriptor() ([]byte, []int)
func (*Command_P2POperation_Operation) GetForce ¶
func (m *Command_P2POperation_Operation) GetForce() bool
func (*Command_P2POperation_Operation) GetKey ¶
func (m *Command_P2POperation_Operation) GetKey() []byte
func (*Command_P2POperation_Operation) GetNewKey ¶
func (m *Command_P2POperation_Operation) GetNewKey() []byte
func (*Command_P2POperation_Operation) GetP2Pop ¶
func (m *Command_P2POperation_Operation) GetP2Pop() *Command_P2POperation
func (*Command_P2POperation_Operation) GetStatus ¶
func (m *Command_P2POperation_Operation) GetStatus() *Command_Status
func (*Command_P2POperation_Operation) GetVersion ¶
func (m *Command_P2POperation_Operation) GetVersion() []byte
func (*Command_P2POperation_Operation) ProtoMessage ¶
func (*Command_P2POperation_Operation) ProtoMessage()
func (*Command_P2POperation_Operation) Reset ¶
func (m *Command_P2POperation_Operation) Reset()
func (*Command_P2POperation_Operation) String ¶
func (m *Command_P2POperation_Operation) String() string
type Command_P2POperation_Peer ¶
type Command_P2POperation_Peer struct { Hostname *string `protobuf:"bytes,1,opt,name=hostname" json:"hostname,omitempty"` Port *int32 `protobuf:"varint,2,opt,name=port" json:"port,omitempty"` Tls *bool `protobuf:"varint,3,opt,name=tls" json:"tls,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_P2POperation_Peer) Descriptor ¶
func (*Command_P2POperation_Peer) Descriptor() ([]byte, []int)
func (*Command_P2POperation_Peer) GetHostname ¶
func (m *Command_P2POperation_Peer) GetHostname() string
func (*Command_P2POperation_Peer) GetPort ¶
func (m *Command_P2POperation_Peer) GetPort() int32
func (*Command_P2POperation_Peer) GetTls ¶
func (m *Command_P2POperation_Peer) GetTls() bool
func (*Command_P2POperation_Peer) ProtoMessage ¶
func (*Command_P2POperation_Peer) ProtoMessage()
func (*Command_P2POperation_Peer) Reset ¶
func (m *Command_P2POperation_Peer) Reset()
func (*Command_P2POperation_Peer) String ¶
func (m *Command_P2POperation_Peer) String() string
type Command_PinOperation ¶
type Command_PinOperation struct { PinOpType *Command_PinOperation_PinOpType `` /* 127-byte string literal not displayed */ XXX_unrecognized []byte `json:"-"` }
Pin Operations are used for special commands that are valid when the device is locked or to be locked. These are unlock, lock and erase. This must come over the TLS connection to protect the confidentiality and integrity. This operations must be used with PinAuth.
func (*Command_PinOperation) Descriptor ¶
func (*Command_PinOperation) Descriptor() ([]byte, []int)
func (*Command_PinOperation) GetPinOpType ¶
func (m *Command_PinOperation) GetPinOpType() Command_PinOperation_PinOpType
func (*Command_PinOperation) ProtoMessage ¶
func (*Command_PinOperation) ProtoMessage()
func (*Command_PinOperation) Reset ¶
func (m *Command_PinOperation) Reset()
func (*Command_PinOperation) String ¶
func (m *Command_PinOperation) String() string
type Command_PinOperation_PinOpType ¶
type Command_PinOperation_PinOpType int32
const ( Command_PinOperation_INVALID_PINOP Command_PinOperation_PinOpType = -1 // The pin will unlock the device Command_PinOperation_UNLOCK_PINOP Command_PinOperation_PinOpType = 1 // This will lock the device. This includes all // configuration and user data. This operation is // secure from even given physical access and // disassembly of the device. Command_PinOperation_LOCK_PINOP Command_PinOperation_PinOpType = 2 // Erase the device. This may be secure // or not. The implication is that it may be faster // than the secure operation. Command_PinOperation_ERASE_PINOP Command_PinOperation_PinOpType = 3 // Erase the device in a way that will // physical access and disassembly of the device // will not Command_PinOperation_SECURE_ERASE_PINOP Command_PinOperation_PinOpType = 4 )
func (Command_PinOperation_PinOpType) Enum ¶
func (x Command_PinOperation_PinOpType) Enum() *Command_PinOperation_PinOpType
func (Command_PinOperation_PinOpType) EnumDescriptor ¶
func (Command_PinOperation_PinOpType) EnumDescriptor() ([]byte, []int)
func (Command_PinOperation_PinOpType) String ¶
func (x Command_PinOperation_PinOpType) String() string
func (*Command_PinOperation_PinOpType) UnmarshalJSON ¶
func (x *Command_PinOperation_PinOpType) UnmarshalJSON(data []byte) error
type Command_PowerLevel ¶
type Command_PowerLevel int32
const ( Command_INVALID_LEVEL Command_PowerLevel = -1 Command_OPERATIONAL Command_PowerLevel = 1 Command_HIBERNATE Command_PowerLevel = 2 Command_SHUTDOWN Command_PowerLevel = 3 Command_FAIL Command_PowerLevel = 4 )
func (Command_PowerLevel) Enum ¶
func (x Command_PowerLevel) Enum() *Command_PowerLevel
func (Command_PowerLevel) EnumDescriptor ¶
func (Command_PowerLevel) EnumDescriptor() ([]byte, []int)
func (Command_PowerLevel) String ¶
func (x Command_PowerLevel) String() string
func (*Command_PowerLevel) UnmarshalJSON ¶
func (x *Command_PowerLevel) UnmarshalJSON(data []byte) error
type Command_PowerManagement ¶
type Command_PowerManagement struct { Level *Command_PowerLevel `protobuf:"varint,1,opt,name=level,enum=com.seagate.kinetic.proto.Command_PowerLevel" json:"level,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_PowerManagement) Descriptor ¶
func (*Command_PowerManagement) Descriptor() ([]byte, []int)
func (*Command_PowerManagement) GetLevel ¶
func (m *Command_PowerManagement) GetLevel() Command_PowerLevel
func (*Command_PowerManagement) ProtoMessage ¶
func (*Command_PowerManagement) ProtoMessage()
func (*Command_PowerManagement) Reset ¶
func (m *Command_PowerManagement) Reset()
func (*Command_PowerManagement) String ¶
func (m *Command_PowerManagement) String() string
type Command_Priority ¶
type Command_Priority int32
const ( Command_NORMAL Command_Priority = 5 Command_LOWEST Command_Priority = 1 Command_LOWER Command_Priority = 3 Command_HIGHER Command_Priority = 7 Command_HIGHEST Command_Priority = 9 )
func (Command_Priority) Enum ¶
func (x Command_Priority) Enum() *Command_Priority
func (Command_Priority) EnumDescriptor ¶
func (Command_Priority) EnumDescriptor() ([]byte, []int)
func (Command_Priority) String ¶
func (x Command_Priority) String() string
func (*Command_Priority) UnmarshalJSON ¶
func (x *Command_Priority) UnmarshalJSON(data []byte) error
type Command_Range ¶
type Command_Range struct { StartKey []byte `protobuf:"bytes,1,opt,name=startKey" json:"startKey,omitempty"` EndKey []byte `protobuf:"bytes,2,opt,name=endKey" json:"endKey,omitempty"` StartKeyInclusive *bool `protobuf:"varint,3,opt,name=startKeyInclusive" json:"startKeyInclusive,omitempty"` EndKeyInclusive *bool `protobuf:"varint,4,opt,name=endKeyInclusive" json:"endKeyInclusive,omitempty"` // The maximum number of keys returned MaxReturned *int32 `protobuf:"varint,5,opt,name=maxReturned" json:"maxReturned,omitempty"` // The keys are searched for and returned in a reverse order. For instance // if the search is startKey="j", endKey="k", maxReturned=2, // reverse=true and the keys "k0", "k1", "k2" exist // the system will return "k2" and "k1" in that order. Reverse *bool `protobuf:"varint,6,opt,name=reverse" json:"reverse,omitempty"` // get range response . Keys [][]byte `protobuf:"bytes,8,rep,name=keys" json:"keys,omitempty"` XXX_unrecognized []byte `json:"-"` }
key range op
func (*Command_Range) Descriptor ¶
func (*Command_Range) Descriptor() ([]byte, []int)
func (*Command_Range) GetEndKey ¶
func (m *Command_Range) GetEndKey() []byte
func (*Command_Range) GetEndKeyInclusive ¶
func (m *Command_Range) GetEndKeyInclusive() bool
func (*Command_Range) GetKeys ¶
func (m *Command_Range) GetKeys() [][]byte
func (*Command_Range) GetMaxReturned ¶
func (m *Command_Range) GetMaxReturned() int32
func (*Command_Range) GetReverse ¶
func (m *Command_Range) GetReverse() bool
func (*Command_Range) GetStartKey ¶
func (m *Command_Range) GetStartKey() []byte
func (*Command_Range) GetStartKeyInclusive ¶
func (m *Command_Range) GetStartKeyInclusive() bool
func (*Command_Range) ProtoMessage ¶
func (*Command_Range) ProtoMessage()
func (*Command_Range) Reset ¶
func (m *Command_Range) Reset()
func (*Command_Range) String ¶
func (m *Command_Range) String() string
type Command_Security ¶
type Command_Security struct { Acl []*Command_Security_ACL `protobuf:"bytes,2,rep,name=acl" json:"acl,omitempty"` // Set the lock and erase pins. OldLockPIN []byte `protobuf:"bytes,3,opt,name=oldLockPIN" json:"oldLockPIN,omitempty"` NewLockPIN []byte `protobuf:"bytes,4,opt,name=newLockPIN" json:"newLockPIN,omitempty"` OldErasePIN []byte `protobuf:"bytes,5,opt,name=oldErasePIN" json:"oldErasePIN,omitempty"` NewErasePIN []byte `protobuf:"bytes,6,opt,name=newErasePIN" json:"newErasePIN,omitempty"` XXX_unrecognized []byte `json:"-"` }
These are persistent options that are retained across power fail and erased on either PIN erase or PIN secure erase.
func (*Command_Security) Descriptor ¶
func (*Command_Security) Descriptor() ([]byte, []int)
func (*Command_Security) GetAcl ¶
func (m *Command_Security) GetAcl() []*Command_Security_ACL
func (*Command_Security) GetNewErasePIN ¶
func (m *Command_Security) GetNewErasePIN() []byte
func (*Command_Security) GetNewLockPIN ¶
func (m *Command_Security) GetNewLockPIN() []byte
func (*Command_Security) GetOldErasePIN ¶
func (m *Command_Security) GetOldErasePIN() []byte
func (*Command_Security) GetOldLockPIN ¶
func (m *Command_Security) GetOldLockPIN() []byte
func (*Command_Security) ProtoMessage ¶
func (*Command_Security) ProtoMessage()
func (*Command_Security) Reset ¶
func (m *Command_Security) Reset()
func (*Command_Security) String ¶
func (m *Command_Security) String() string
type Command_Security_ACL ¶
type Command_Security_ACL struct { Identity *int64 `protobuf:"varint,1,opt,name=identity" json:"identity,omitempty"` Key []byte `protobuf:"bytes,2,opt,name=key" json:"key,omitempty"` HmacAlgorithm *Command_Security_ACL_HMACAlgorithm `` /* 139-byte string literal not displayed */ // value that must be in the key for read, write, range requests. If none are specified // then no checking occurs. If one or more is specified, one must match or the request // is rejected Scope []*Command_Security_ACL_Scope `protobuf:"bytes,4,rep,name=scope" json:"scope,omitempty"` // The maxPriority is checked against the header priority and range // priority (if present) fields. The priority must be greater than // or equal to this maxPriority field. MaxPriority *Command_Priority `protobuf:"varint,5,opt,name=maxPriority,enum=com.seagate.kinetic.proto.Command_Priority" json:"maxPriority,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_Security_ACL) Descriptor ¶
func (*Command_Security_ACL) Descriptor() ([]byte, []int)
func (*Command_Security_ACL) GetHmacAlgorithm ¶
func (m *Command_Security_ACL) GetHmacAlgorithm() Command_Security_ACL_HMACAlgorithm
func (*Command_Security_ACL) GetIdentity ¶
func (m *Command_Security_ACL) GetIdentity() int64
func (*Command_Security_ACL) GetKey ¶
func (m *Command_Security_ACL) GetKey() []byte
func (*Command_Security_ACL) GetMaxPriority ¶
func (m *Command_Security_ACL) GetMaxPriority() Command_Priority
func (*Command_Security_ACL) GetScope ¶
func (m *Command_Security_ACL) GetScope() []*Command_Security_ACL_Scope
func (*Command_Security_ACL) ProtoMessage ¶
func (*Command_Security_ACL) ProtoMessage()
func (*Command_Security_ACL) Reset ¶
func (m *Command_Security_ACL) Reset()
func (*Command_Security_ACL) String ¶
func (m *Command_Security_ACL) String() string
type Command_Security_ACL_HMACAlgorithm ¶
type Command_Security_ACL_HMACAlgorithm int32
const ( Command_Security_ACL_INVALID_HMAC_ALGORITHM Command_Security_ACL_HMACAlgorithm = -1 // 0 is reserved; do not use Command_Security_ACL_HmacSHA1 Command_Security_ACL_HMACAlgorithm = 1 )
func (Command_Security_ACL_HMACAlgorithm) Enum ¶
func (x Command_Security_ACL_HMACAlgorithm) Enum() *Command_Security_ACL_HMACAlgorithm
func (Command_Security_ACL_HMACAlgorithm) EnumDescriptor ¶
func (Command_Security_ACL_HMACAlgorithm) EnumDescriptor() ([]byte, []int)
func (Command_Security_ACL_HMACAlgorithm) String ¶
func (x Command_Security_ACL_HMACAlgorithm) String() string
func (*Command_Security_ACL_HMACAlgorithm) UnmarshalJSON ¶
func (x *Command_Security_ACL_HMACAlgorithm) UnmarshalJSON(data []byte) error
type Command_Security_ACL_Permission ¶
type Command_Security_ACL_Permission int32
const ( Command_Security_ACL_INVALID_PERMISSION Command_Security_ACL_Permission = -1 Command_Security_ACL_READ Command_Security_ACL_Permission = 0 Command_Security_ACL_WRITE Command_Security_ACL_Permission = 1 Command_Security_ACL_DELETE Command_Security_ACL_Permission = 2 Command_Security_ACL_RANGE Command_Security_ACL_Permission = 3 Command_Security_ACL_SETUP Command_Security_ACL_Permission = 4 Command_Security_ACL_P2POP Command_Security_ACL_Permission = 5 Command_Security_ACL_GETLOG Command_Security_ACL_Permission = 7 Command_Security_ACL_SECURITY Command_Security_ACL_Permission = 8 Command_Security_ACL_POWER_MANAGEMENT Command_Security_ACL_Permission = 9 )
func (Command_Security_ACL_Permission) Enum ¶
func (x Command_Security_ACL_Permission) Enum() *Command_Security_ACL_Permission
func (Command_Security_ACL_Permission) EnumDescriptor ¶
func (Command_Security_ACL_Permission) EnumDescriptor() ([]byte, []int)
func (Command_Security_ACL_Permission) String ¶
func (x Command_Security_ACL_Permission) String() string
func (*Command_Security_ACL_Permission) UnmarshalJSON ¶
func (x *Command_Security_ACL_Permission) UnmarshalJSON(data []byte) error
type Command_Security_ACL_Scope ¶
type Command_Security_ACL_Scope struct { Offset *int64 `protobuf:"varint,1,opt,name=offset" json:"offset,omitempty"` Value []byte `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` Permission []Command_Security_ACL_Permission `` /* 130-byte string literal not displayed */ TlsRequired *bool `protobuf:"varint,4,opt,name=TlsRequired" json:"TlsRequired,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*Command_Security_ACL_Scope) Descriptor ¶
func (*Command_Security_ACL_Scope) Descriptor() ([]byte, []int)
func (*Command_Security_ACL_Scope) GetOffset ¶
func (m *Command_Security_ACL_Scope) GetOffset() int64
func (*Command_Security_ACL_Scope) GetPermission ¶
func (m *Command_Security_ACL_Scope) GetPermission() []Command_Security_ACL_Permission
func (*Command_Security_ACL_Scope) GetTlsRequired ¶
func (m *Command_Security_ACL_Scope) GetTlsRequired() bool
func (*Command_Security_ACL_Scope) GetValue ¶
func (m *Command_Security_ACL_Scope) GetValue() []byte
func (*Command_Security_ACL_Scope) ProtoMessage ¶
func (*Command_Security_ACL_Scope) ProtoMessage()
func (*Command_Security_ACL_Scope) Reset ¶
func (m *Command_Security_ACL_Scope) Reset()
func (*Command_Security_ACL_Scope) String ¶
func (m *Command_Security_ACL_Scope) String() string
type Command_Setup ¶
type Command_Setup struct { // The cluster version to be checked. The default if never set is 0. // If this is missing, it is assumed to be unchanged; // This is persistent between boots of the device. NewClusterVersion *int64 `protobuf:"varint,1,opt,name=newClusterVersion" json:"newClusterVersion,omitempty"` // indicates the presence of a firmware load in the data portion of this // message. The firmware is itself protected on its own for integrity, // authenticity, etc. FirmwareDownload *bool `protobuf:"varint,5,opt,name=firmwareDownload" json:"firmwareDownload,omitempty"` XXX_unrecognized []byte `json:"-"` }
if any or all of these are fields are included, they are set. These are persistent options that are retained across power fail and erased on either PIN erase or PIN secure erase.
func (*Command_Setup) Descriptor ¶
func (*Command_Setup) Descriptor() ([]byte, []int)
func (*Command_Setup) GetFirmwareDownload ¶
func (m *Command_Setup) GetFirmwareDownload() bool
func (*Command_Setup) GetNewClusterVersion ¶
func (m *Command_Setup) GetNewClusterVersion() int64
func (*Command_Setup) ProtoMessage ¶
func (*Command_Setup) ProtoMessage()
func (*Command_Setup) Reset ¶
func (m *Command_Setup) Reset()
func (*Command_Setup) String ¶
func (m *Command_Setup) String() string
type Command_Status ¶
type Command_Status struct { // status code Code *Command_Status_StatusCode `protobuf:"varint,1,opt,name=code,enum=com.seagate.kinetic.proto.Command_Status_StatusCode" json:"code,omitempty"` // status message StatusMessage *string `protobuf:"bytes,2,opt,name=statusMessage" json:"statusMessage,omitempty"` // optional information comes with status DetailedMessage []byte `protobuf:"bytes,3,opt,name=detailedMessage" json:"detailedMessage,omitempty"` XXX_unrecognized []byte `json:"-"` }
operation status
func (*Command_Status) Descriptor ¶
func (*Command_Status) Descriptor() ([]byte, []int)
func (*Command_Status) GetCode ¶
func (m *Command_Status) GetCode() Command_Status_StatusCode
func (*Command_Status) GetDetailedMessage ¶
func (m *Command_Status) GetDetailedMessage() []byte
func (*Command_Status) GetStatusMessage ¶
func (m *Command_Status) GetStatusMessage() string
func (*Command_Status) ProtoMessage ¶
func (*Command_Status) ProtoMessage()
func (*Command_Status) Reset ¶
func (m *Command_Status) Reset()
func (*Command_Status) String ¶
func (m *Command_Status) String() string
type Command_Status_StatusCode ¶
type Command_Status_StatusCode int32
enum of status code
const ( // Must come first, so default is invalid Command_Status_INVALID_STATUS_CODE Command_Status_StatusCode = -1 // for a P2P operation, there was a reason the list was incomplete. This is for items // that were not attempted. Command_Status_NOT_ATTEMPTED Command_Status_StatusCode = 0 Command_Status_SUCCESS Command_Status_StatusCode = 1 Command_Status_HMAC_FAILURE Command_Status_StatusCode = 2 Command_Status_NOT_AUTHORIZED Command_Status_StatusCode = 3 Command_Status_VERSION_FAILURE Command_Status_StatusCode = 4 Command_Status_INTERNAL_ERROR Command_Status_StatusCode = 5 Command_Status_HEADER_REQUIRED Command_Status_StatusCode = 6 Command_Status_NOT_FOUND Command_Status_StatusCode = 7 Command_Status_VERSION_MISMATCH Command_Status_StatusCode = 8 // If there are too many requests in the device at this time, requests // will be rejected with this error message. The common response is to // wait and retry the operation with an exponential back-off. Command_Status_SERVICE_BUSY Command_Status_StatusCode = 9 // A long operation was started and a timeout happened mid operation. This // does not imply a failure. Command_Status_EXPIRED Command_Status_StatusCode = 10 // A data error happened and either earlyExit was set or the timeout happened. Command_Status_DATA_ERROR Command_Status_StatusCode = 11 // A data error happened and all possible error recovery operations have been // performed. There is no value to trying this again. If the system has the ability // to determine the correct information, writing the data again can get rid Command_Status_PERM_DATA_ERROR Command_Status_StatusCode = 12 // A TCP connection to the remote peer failed. This is only for the P2P Operation Command_Status_REMOTE_CONNECTION_ERROR Command_Status_StatusCode = 13 // When the device is full, it returns this error. The background scrubbing may free space, // so this error may go away Command_Status_NO_SPACE Command_Status_StatusCode = 14 // In the set security, an HmacAlgorithm was specified as Unknown or there is a protocol // version mis-match Command_Status_NO_SUCH_HMAC_ALGORITHM Command_Status_StatusCode = 15 // The request is not valid. Subsequent attempts with the same request will return the same code. // Examples: GET does not specify keyValue message, GETKEYRANGE operation does not specify startKey, etc Command_Status_INVALID_REQUEST Command_Status_StatusCode = 16 // For P2P Requests, the operation was executed successfully but some nested operations // did not succeed. This indicates that callers should review the status of nested operations. // This status should only be used in the Command > Status, not in the Status messages // of nested P2POperations Command_Status_NESTED_OPERATION_ERRORS Command_Status_StatusCode = 17 // If the device is currently locked and can not validate // the hmac. This is returned as an status // and the connection is terminated. Command_Status_DEVICE_LOCKED Command_Status_StatusCode = 18 // The device was already unlocked. The validity of the // pin was NOT checked. The connection remains open. Command_Status_DEVICE_ALREADY_UNLOCKED Command_Status_StatusCode = 19 // The connection is being terminated. Details as to why are // in the message string. Command_Status_CONNECTION_TERMINATED Command_Status_StatusCode = 20 // During a batch operation, the only operations allowed are put " // and delete. This error is put against the offending command and " // the rest of the commands and the END_BATCH return NOT_ATTEMPTED." Command_Status_INVALID_BATCH Command_Status_StatusCode = 21 // the status is returned to caller if commands are received when // device is in hibernate state Command_Status_HIBERNATE Command_Status_StatusCode = 22 // the status is returned to caller if commands are received when // device is shutting down. Command_Status_SHUTDOWN Command_Status_StatusCode = 23 )
func (Command_Status_StatusCode) Enum ¶
func (x Command_Status_StatusCode) Enum() *Command_Status_StatusCode
func (Command_Status_StatusCode) EnumDescriptor ¶
func (Command_Status_StatusCode) EnumDescriptor() ([]byte, []int)
func (Command_Status_StatusCode) String ¶
func (x Command_Status_StatusCode) String() string
func (*Command_Status_StatusCode) UnmarshalJSON ¶
func (x *Command_Status_StatusCode) UnmarshalJSON(data []byte) error
type Command_Synchronization ¶
type Command_Synchronization int32
const ( Command_INVALID_SYNCHRONIZATION Command_Synchronization = -1 Command_WRITETHROUGH Command_Synchronization = 1 Command_WRITEBACK Command_Synchronization = 2 Command_FLUSH Command_Synchronization = 3 )
func (Command_Synchronization) Enum ¶
func (x Command_Synchronization) Enum() *Command_Synchronization
func (Command_Synchronization) EnumDescriptor ¶
func (Command_Synchronization) EnumDescriptor() ([]byte, []int)
func (Command_Synchronization) String ¶
func (x Command_Synchronization) String() string
func (*Command_Synchronization) UnmarshalJSON ¶
func (x *Command_Synchronization) UnmarshalJSON(data []byte) error
type Local ¶
type Local struct { ProtocolVersion *string `protobuf:"bytes,1,opt,name=protocolVersion,def=3.1.0" json:"protocolVersion,omitempty"` XXX_unrecognized []byte `json:"-"` }
this is a local message to allow the program to read the protocol version number by building this message and then reading the value.
func (*Local) Descriptor ¶
func (*Local) GetProtocolVersion ¶
func (*Local) ProtoMessage ¶
func (*Local) ProtoMessage()
type Message ¶
type Message struct { // Every message must be one of the following types. AuthType *Message_AuthType `protobuf:"varint,4,opt,name=authType,enum=com.seagate.kinetic.proto.Message_AuthType" json:"authType,omitempty"` // Normal messages HmacAuth *Message_HMACauth `protobuf:"bytes,5,opt,name=hmacAuth" json:"hmacAuth,omitempty"` // for Pin based operations. These include device unlock and // device erase PinAuth *Message_PINauth `protobuf:"bytes,6,opt,name=pinAuth" json:"pinAuth,omitempty"` // the embedded message providing the request (for HMACauth) and // the response (for all auth types). CommandBytes []byte `protobuf:"bytes,7,opt,name=commandBytes" json:"commandBytes,omitempty"` XXX_unrecognized []byte `json:"-"` }
THe message is an authorization and command bytes.
func (*Message) Descriptor ¶
func (*Message) GetAuthType ¶
func (m *Message) GetAuthType() Message_AuthType
func (*Message) GetCommandBytes ¶
func (*Message) GetHmacAuth ¶
func (m *Message) GetHmacAuth() *Message_HMACauth
func (*Message) GetPinAuth ¶
func (m *Message) GetPinAuth() *Message_PINauth
func (*Message) ProtoMessage ¶
func (*Message) ProtoMessage()
type Message_AuthType ¶
type Message_AuthType int32
The Message Type determines how the the message is to be processed.
const ( // if the message type is unknown, close the connection Message_INVALID_AUTH_TYPE Message_AuthType = -1 // This is for normal traffic. Check the HMAC of the command and // if correct, process the command. Message_HMACAUTH Message_AuthType = 1 // device unlock and ISE command. These must come over the TLS connection. // If they do not, close the connection. If it is over // the TLS connection, execute the pin operation. Message_PINAUTH Message_AuthType = 2 // In the event that the device is going to close the connection, an // unsolicited status will be returned first. Message_UNSOLICITEDSTATUS Message_AuthType = 3 )
func (Message_AuthType) Enum ¶
func (x Message_AuthType) Enum() *Message_AuthType
func (Message_AuthType) EnumDescriptor ¶
func (Message_AuthType) EnumDescriptor() ([]byte, []int)
func (Message_AuthType) String ¶
func (x Message_AuthType) String() string
func (*Message_AuthType) UnmarshalJSON ¶
func (x *Message_AuthType) UnmarshalJSON(data []byte) error
type Message_HMACauth ¶
type Message_HMACauth struct { // The "identity" identifies the requester and the key and algorithm to // be used for hmac. Identity *int64 `protobuf:"varint,1,opt,name=identity" json:"identity,omitempty"` Hmac []byte `protobuf:"bytes,2,opt,name=hmac" json:"hmac,omitempty"` XXX_unrecognized []byte `json:"-"` }
This is for normal message to the device and for responses. These are allowed once the device is unlocked. The HMAC provides for authenticity, Integrity and to enforce roles.
func (*Message_HMACauth) Descriptor ¶
func (*Message_HMACauth) Descriptor() ([]byte, []int)
func (*Message_HMACauth) GetHmac ¶
func (m *Message_HMACauth) GetHmac() []byte
func (*Message_HMACauth) GetIdentity ¶
func (m *Message_HMACauth) GetIdentity() int64
func (*Message_HMACauth) ProtoMessage ¶
func (*Message_HMACauth) ProtoMessage()
func (*Message_HMACauth) Reset ¶
func (m *Message_HMACauth) Reset()
func (*Message_HMACauth) String ¶
func (m *Message_HMACauth) String() string
type Message_PINauth ¶
type Message_PINauth struct { // The pin necessary to make the operations valid Pin []byte `protobuf:"bytes,1,opt,name=pin" json:"pin,omitempty"` XXX_unrecognized []byte `json:"-"` }
Pin based authentication for Pin operations.
func (*Message_PINauth) Descriptor ¶
func (*Message_PINauth) Descriptor() ([]byte, []int)
func (*Message_PINauth) GetPin ¶
func (m *Message_PINauth) GetPin() []byte
func (*Message_PINauth) ProtoMessage ¶
func (*Message_PINauth) ProtoMessage()
func (*Message_PINauth) Reset ¶
func (m *Message_PINauth) Reset()
func (*Message_PINauth) String ¶
func (m *Message_PINauth) String() string