Documentation
¶
Index ¶
- Variables
- type Session
- func (*Session) Descriptor() ([]byte, []int)deprecated
- func (x *Session) GetAuthTokenId() string
- func (x *Session) GetCertificate() []byte
- func (x *Session) GetCreatedTime() *timestamp.Timestamp
- func (x *Session) GetEndpoint() string
- func (x *Session) GetExpirationTime() *timestamp.Timestamp
- func (x *Session) GetHostId() string
- func (x *Session) GetHostSetId() string
- func (x *Session) GetId() string
- func (x *Session) GetPrivateKey() []byte
- func (x *Session) GetScope() *scopes.ScopeInfo
- func (x *Session) GetScopeId() string
- func (x *Session) GetStates() []*SessionState
- func (x *Session) GetStatus() string
- func (x *Session) GetTargetId() string
- func (x *Session) GetType() string
- func (x *Session) GetUpdatedTime() *timestamp.Timestamp
- func (x *Session) GetUserId() string
- func (x *Session) GetVersion() uint32
- func (x *Session) GetWorkerInfo() []*WorkerInfo
- func (*Session) ProtoMessage()
- func (x *Session) ProtoReflect() protoreflect.Message
- func (x *Session) Reset()
- func (x *Session) String() string
- type SessionState
- func (*SessionState) Descriptor() ([]byte, []int)deprecated
- func (x *SessionState) GetEndTime() *timestamp.Timestamp
- func (x *SessionState) GetStartTime() *timestamp.Timestamp
- func (x *SessionState) GetStatus() string
- func (*SessionState) ProtoMessage()
- func (x *SessionState) ProtoReflect() protoreflect.Message
- func (x *SessionState) Reset()
- func (x *SessionState) String() string
- type WorkerInfo
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_api_resources_sessions_v1_session_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Session ¶
type Session struct {
// The ID of the resource
// Output only.
Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty"`
// The id of the parent of this resource. This must be defined for creation
// of this resource, but is otherwise read only.
TargetId string `protobuf:"bytes,20,opt,name=target_id,proto3" json:"target_id,omitempty"`
// Scope information for this resource
// Output only.
Scope *scopes.ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"`
// The time this resource was created
// Output only.
CreatedTime *timestamp.Timestamp `protobuf:"bytes,40,opt,name=created_time,proto3" json:"created_time,omitempty"`
// The time this resource was last updated.
// Output only.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,50,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// After this time the connection will be expired, e.g. forcefully terminated
ExpirationTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=expiration_time,proto3" json:"expiration_time,omitempty"`
// The version can be used in subsequent write requests to ensure this
// resource has not changed and to fail the write if it has.
Version uint32 `protobuf:"varint,70,opt,name=version,proto3" json:"version,omitempty"`
// Type of the session (e.g. tcp, ssh, etc.)
Type string `protobuf:"bytes,80,opt,name=type,proto3" json:"type,omitempty"`
// The id of the token used to authenticate.
AuthTokenId string `protobuf:"bytes,90,opt,name=auth_token_id,proto3" json:"auth_token_id,omitempty"`
// The ID of the user that requested the session
UserId string `protobuf:"bytes,100,opt,name=user_id,proto3" json:"user_id,omitempty"`
// The host set id used by the session's target
HostSetId string `protobuf:"bytes,110,opt,name=host_set_id,proto3" json:"host_set_id,omitempty"`
// The host id used by the session
HostId string `protobuf:"bytes,120,opt,name=host_id,proto3" json:"host_id,omitempty"`
// The scope of the session
ScopeId string `protobuf:"bytes,130,opt,name=scope_id,proto3" json:"scope_id,omitempty"`
// The endpoint of the session
Endpoint string `protobuf:"bytes,140,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
// The states of this session in descending from the current state to the
// first.
States []*SessionState `protobuf:"bytes,150,rep,name=states,proto3" json:"states,omitempty"`
// The name of the current status of this session.
Status string `protobuf:"bytes,160,opt,name=status,proto3" json:"status,omitempty"`
// Worker information. The first worker in the slice should be prioritized.
WorkerInfo []*WorkerInfo `protobuf:"bytes,170,rep,name=worker_info,proto3" json:"worker_info,omitempty"`
// Deprecated, to be moved to another proto by another PR:
// The certificate to use when connecting (or if using custom certs, to
// serve as the "login"). Raw DER bytes.
Certificate []byte `protobuf:"bytes,220,opt,name=certificate,proto3" json:"certificate,omitempty"`
// The private key to use when connecting (or if using custom certs, to pass
// as the "password").
PrivateKey []byte `protobuf:"bytes,230,opt,name=private_key,proto3" json:"private_key,omitempty"`
// contains filtered or unexported fields
}
Session contains all fields related to a Session resource
func (*Session) Descriptor
deprecated
func (*Session) GetAuthTokenId ¶
func (*Session) GetCertificate ¶
func (*Session) GetCreatedTime ¶
func (*Session) GetEndpoint ¶
func (*Session) GetExpirationTime ¶
func (*Session) GetHostSetId ¶
func (*Session) GetPrivateKey ¶
func (*Session) GetScopeId ¶
func (*Session) GetStates ¶
func (x *Session) GetStates() []*SessionState
func (*Session) GetTargetId ¶
func (*Session) GetUpdatedTime ¶
func (*Session) GetVersion ¶
func (*Session) GetWorkerInfo ¶
func (x *Session) GetWorkerInfo() []*WorkerInfo
func (*Session) ProtoMessage ¶
func (*Session) ProtoMessage()
func (*Session) ProtoReflect ¶
func (x *Session) ProtoReflect() protoreflect.Message
type SessionState ¶
type SessionState struct {
// This is the status of the session. For example "pending", "active",
// "canceling", "terminated".
Status string `protobuf:"bytes,10,opt,name=status,proto3" json:"status,omitempty"`
// The time the session entered this state.
// Output only.
StartTime *timestamp.Timestamp `protobuf:"bytes,20,opt,name=start_time,proto3" json:"start_time,omitempty"`
// The time the session stopped being in this state.
// Output only.
EndTime *timestamp.Timestamp `protobuf:"bytes,30,opt,name=end_time,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*SessionState) Descriptor
deprecated
func (*SessionState) Descriptor() ([]byte, []int)
Deprecated: Use SessionState.ProtoReflect.Descriptor instead.
func (*SessionState) GetEndTime ¶
func (x *SessionState) GetEndTime() *timestamp.Timestamp
func (*SessionState) GetStartTime ¶
func (x *SessionState) GetStartTime() *timestamp.Timestamp
func (*SessionState) GetStatus ¶
func (x *SessionState) GetStatus() string
func (*SessionState) ProtoMessage ¶
func (*SessionState) ProtoMessage()
func (*SessionState) ProtoReflect ¶
func (x *SessionState) ProtoReflect() protoreflect.Message
func (*SessionState) Reset ¶
func (x *SessionState) Reset()
func (*SessionState) String ¶
func (x *SessionState) String() string
type WorkerInfo ¶
type WorkerInfo struct {
// The address of the worker
Address string `protobuf:"bytes,10,opt,name=address,proto3" json:"address,omitempty"`
// contains filtered or unexported fields
}
func (*WorkerInfo) Descriptor
deprecated
func (*WorkerInfo) Descriptor() ([]byte, []int)
Deprecated: Use WorkerInfo.ProtoReflect.Descriptor instead.
func (*WorkerInfo) GetAddress ¶
func (x *WorkerInfo) GetAddress() string
func (*WorkerInfo) ProtoMessage ¶
func (*WorkerInfo) ProtoMessage()
func (*WorkerInfo) ProtoReflect ¶
func (x *WorkerInfo) ProtoReflect() protoreflect.Message
func (*WorkerInfo) Reset ¶
func (x *WorkerInfo) Reset()
func (*WorkerInfo) String ¶
func (x *WorkerInfo) String() string
Click to show internal directories.
Click to hide internal directories.