server

package
v0.0.0-...-c201ef6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Default_GetFlagResponsePB_Valid = bool(true)
)

Default values for GetFlagResponsePB fields.

View Source
const (
	Default_SetFlagRequestPB_Force = bool(false)
)

Default values for SetFlagRequestPB fields.

Variables

View Source
var (
	SetFlagResponsePB_Code_name = map[int32]string{
		0: "UNKNOWN",
		1: "SUCCESS",
		2: "NO_SUCH_FLAG",
		3: "BAD_VALUE",
		4: "NOT_SAFE",
	}
	SetFlagResponsePB_Code_value = map[string]int32{
		"UNKNOWN":      0,
		"SUCCESS":      1,
		"NO_SUCH_FLAG": 2,
		"BAD_VALUE":    3,
		"NOT_SAFE":     4,
	}
)

Enum value maps for SetFlagResponsePB_Code.

View Source
var File_yb_server_server_base_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type FlushCoverageRequestPB

type FlushCoverageRequestPB struct {
	// contains filtered or unexported fields
}

Attempt to flush coverage information to disk, if running a coverage build.

func (*FlushCoverageRequestPB) Descriptor deprecated

func (*FlushCoverageRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use FlushCoverageRequestPB.ProtoReflect.Descriptor instead.

func (*FlushCoverageRequestPB) MarshalJSON

func (m *FlushCoverageRequestPB) MarshalJSON() ([]byte, error)

func (*FlushCoverageRequestPB) ProtoMessage

func (*FlushCoverageRequestPB) ProtoMessage()

func (*FlushCoverageRequestPB) ProtoReflect

func (x *FlushCoverageRequestPB) ProtoReflect() protoreflect.Message

func (*FlushCoverageRequestPB) Reset

func (x *FlushCoverageRequestPB) Reset()

func (*FlushCoverageRequestPB) String

func (x *FlushCoverageRequestPB) String() string

func (*FlushCoverageRequestPB) UnmarshalJSON

func (m *FlushCoverageRequestPB) UnmarshalJSON(b []byte) error

type FlushCoverageResponsePB

type FlushCoverageResponsePB struct {

	// If the current build is not a coverage build, returns false.
	Success *bool `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	// contains filtered or unexported fields
}

func (*FlushCoverageResponsePB) Descriptor deprecated

func (*FlushCoverageResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use FlushCoverageResponsePB.ProtoReflect.Descriptor instead.

func (*FlushCoverageResponsePB) GetSuccess

func (x *FlushCoverageResponsePB) GetSuccess() bool

func (*FlushCoverageResponsePB) MarshalJSON

func (m *FlushCoverageResponsePB) MarshalJSON() ([]byte, error)

func (*FlushCoverageResponsePB) ProtoMessage

func (*FlushCoverageResponsePB) ProtoMessage()

func (*FlushCoverageResponsePB) ProtoReflect

func (x *FlushCoverageResponsePB) ProtoReflect() protoreflect.Message

func (*FlushCoverageResponsePB) Reset

func (x *FlushCoverageResponsePB) Reset()

func (*FlushCoverageResponsePB) String

func (x *FlushCoverageResponsePB) String() string

func (*FlushCoverageResponsePB) UnmarshalJSON

func (m *FlushCoverageResponsePB) UnmarshalJSON(b []byte) error

type GenericService

type GenericService interface {
	SetFlag(request *SetFlagRequestPB) (*SetFlagResponsePB, error)
	GetFlag(request *GetFlagRequestPB) (*GetFlagResponsePB, error)
	RefreshFlags(request *RefreshFlagsRequestPB) (*RefreshFlagsResponsePB, error)
	FlushCoverage(request *FlushCoverageRequestPB) (*FlushCoverageResponsePB, error)
	ServerClock(request *ServerClockRequestPB) (*ServerClockResponsePB, error)
	GetStatus(request *GetStatusRequestPB) (*GetStatusResponsePB, error)
	Ping(request *PingRequestPB) (*PingResponsePB, error)
}

service: yb.server.GenericService service: GenericService

type GenericServiceImpl

type GenericServiceImpl struct {
	Log       logr.Logger
	Messenger message.Messenger
}

func (*GenericServiceImpl) FlushCoverage

func (*GenericServiceImpl) GetFlag

func (*GenericServiceImpl) GetStatus

func (*GenericServiceImpl) Ping

func (s *GenericServiceImpl) Ping(request *PingRequestPB) (*PingResponsePB, error)

func (*GenericServiceImpl) RefreshFlags

func (*GenericServiceImpl) ServerClock

func (*GenericServiceImpl) SetFlag

type GetFlagRequestPB

type GetFlagRequestPB struct {
	Flag *string `protobuf:"bytes,1,opt,name=flag" json:"flag,omitempty"`
	// contains filtered or unexported fields
}

Get the value of the gflag with the given flag name.

func (*GetFlagRequestPB) Descriptor deprecated

func (*GetFlagRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use GetFlagRequestPB.ProtoReflect.Descriptor instead.

func (*GetFlagRequestPB) GetFlag

func (x *GetFlagRequestPB) GetFlag() string

func (*GetFlagRequestPB) MarshalJSON

func (m *GetFlagRequestPB) MarshalJSON() ([]byte, error)

func (*GetFlagRequestPB) ProtoMessage

func (*GetFlagRequestPB) ProtoMessage()

func (*GetFlagRequestPB) ProtoReflect

func (x *GetFlagRequestPB) ProtoReflect() protoreflect.Message

func (*GetFlagRequestPB) Reset

func (x *GetFlagRequestPB) Reset()

func (*GetFlagRequestPB) String

func (x *GetFlagRequestPB) String() string

func (*GetFlagRequestPB) UnmarshalJSON

func (m *GetFlagRequestPB) UnmarshalJSON(b []byte) error

type GetFlagResponsePB

type GetFlagResponsePB struct {
	Valid *bool   `protobuf:"varint,1,opt,name=valid,def=1" json:"valid,omitempty"`
	Value *string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

If the flag name is valid, the value is set to its current value. Else the valid field will be set to false.

func (*GetFlagResponsePB) Descriptor deprecated

func (*GetFlagResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use GetFlagResponsePB.ProtoReflect.Descriptor instead.

func (*GetFlagResponsePB) GetValid

func (x *GetFlagResponsePB) GetValid() bool

func (*GetFlagResponsePB) GetValue

func (x *GetFlagResponsePB) GetValue() string

func (*GetFlagResponsePB) MarshalJSON

func (m *GetFlagResponsePB) MarshalJSON() ([]byte, error)

func (*GetFlagResponsePB) ProtoMessage

func (*GetFlagResponsePB) ProtoMessage()

func (*GetFlagResponsePB) ProtoReflect

func (x *GetFlagResponsePB) ProtoReflect() protoreflect.Message

func (*GetFlagResponsePB) Reset

func (x *GetFlagResponsePB) Reset()

func (*GetFlagResponsePB) String

func (x *GetFlagResponsePB) String() string

func (*GetFlagResponsePB) UnmarshalJSON

func (m *GetFlagResponsePB) UnmarshalJSON(b []byte) error

type GetStatusRequestPB

type GetStatusRequestPB struct {
	// contains filtered or unexported fields
}

Requests the server's status and version info

func (*GetStatusRequestPB) Descriptor deprecated

func (*GetStatusRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusRequestPB.ProtoReflect.Descriptor instead.

func (*GetStatusRequestPB) MarshalJSON

func (m *GetStatusRequestPB) MarshalJSON() ([]byte, error)

func (*GetStatusRequestPB) ProtoMessage

func (*GetStatusRequestPB) ProtoMessage()

func (*GetStatusRequestPB) ProtoReflect

func (x *GetStatusRequestPB) ProtoReflect() protoreflect.Message

func (*GetStatusRequestPB) Reset

func (x *GetStatusRequestPB) Reset()

func (*GetStatusRequestPB) String

func (x *GetStatusRequestPB) String() string

func (*GetStatusRequestPB) UnmarshalJSON

func (m *GetStatusRequestPB) UnmarshalJSON(b []byte) error

type GetStatusResponsePB

type GetStatusResponsePB struct {
	Status *ServerStatusPB `protobuf:"bytes,1,req,name=status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusResponsePB) Descriptor deprecated

func (*GetStatusResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusResponsePB.ProtoReflect.Descriptor instead.

func (*GetStatusResponsePB) GetStatus

func (x *GetStatusResponsePB) GetStatus() *ServerStatusPB

func (*GetStatusResponsePB) MarshalJSON

func (m *GetStatusResponsePB) MarshalJSON() ([]byte, error)

func (*GetStatusResponsePB) ProtoMessage

func (*GetStatusResponsePB) ProtoMessage()

func (*GetStatusResponsePB) ProtoReflect

func (x *GetStatusResponsePB) ProtoReflect() protoreflect.Message

func (*GetStatusResponsePB) Reset

func (x *GetStatusResponsePB) Reset()

func (*GetStatusResponsePB) String

func (x *GetStatusResponsePB) String() string

func (*GetStatusResponsePB) UnmarshalJSON

func (m *GetStatusResponsePB) UnmarshalJSON(b []byte) error

type PingRequestPB

type PingRequestPB struct {
	// contains filtered or unexported fields
}

func (*PingRequestPB) Descriptor deprecated

func (*PingRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use PingRequestPB.ProtoReflect.Descriptor instead.

func (*PingRequestPB) MarshalJSON

func (m *PingRequestPB) MarshalJSON() ([]byte, error)

func (*PingRequestPB) ProtoMessage

func (*PingRequestPB) ProtoMessage()

func (*PingRequestPB) ProtoReflect

func (x *PingRequestPB) ProtoReflect() protoreflect.Message

func (*PingRequestPB) Reset

func (x *PingRequestPB) Reset()

func (*PingRequestPB) String

func (x *PingRequestPB) String() string

func (*PingRequestPB) UnmarshalJSON

func (m *PingRequestPB) UnmarshalJSON(b []byte) error

type PingResponsePB

type PingResponsePB struct {
	// contains filtered or unexported fields
}

func (*PingResponsePB) Descriptor deprecated

func (*PingResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use PingResponsePB.ProtoReflect.Descriptor instead.

func (*PingResponsePB) MarshalJSON

func (m *PingResponsePB) MarshalJSON() ([]byte, error)

func (*PingResponsePB) ProtoMessage

func (*PingResponsePB) ProtoMessage()

func (*PingResponsePB) ProtoReflect

func (x *PingResponsePB) ProtoReflect() protoreflect.Message

func (*PingResponsePB) Reset

func (x *PingResponsePB) Reset()

func (*PingResponsePB) String

func (x *PingResponsePB) String() string

func (*PingResponsePB) UnmarshalJSON

func (m *PingResponsePB) UnmarshalJSON(b []byte) error

type RefreshFlagsRequestPB

type RefreshFlagsRequestPB struct {
	// contains filtered or unexported fields
}

func (*RefreshFlagsRequestPB) Descriptor deprecated

func (*RefreshFlagsRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use RefreshFlagsRequestPB.ProtoReflect.Descriptor instead.

func (*RefreshFlagsRequestPB) MarshalJSON

func (m *RefreshFlagsRequestPB) MarshalJSON() ([]byte, error)

func (*RefreshFlagsRequestPB) ProtoMessage

func (*RefreshFlagsRequestPB) ProtoMessage()

func (*RefreshFlagsRequestPB) ProtoReflect

func (x *RefreshFlagsRequestPB) ProtoReflect() protoreflect.Message

func (*RefreshFlagsRequestPB) Reset

func (x *RefreshFlagsRequestPB) Reset()

func (*RefreshFlagsRequestPB) String

func (x *RefreshFlagsRequestPB) String() string

func (*RefreshFlagsRequestPB) UnmarshalJSON

func (m *RefreshFlagsRequestPB) UnmarshalJSON(b []byte) error

type RefreshFlagsResponsePB

type RefreshFlagsResponsePB struct {
	// contains filtered or unexported fields
}

func (*RefreshFlagsResponsePB) Descriptor deprecated

func (*RefreshFlagsResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use RefreshFlagsResponsePB.ProtoReflect.Descriptor instead.

func (*RefreshFlagsResponsePB) MarshalJSON

func (m *RefreshFlagsResponsePB) MarshalJSON() ([]byte, error)

func (*RefreshFlagsResponsePB) ProtoMessage

func (*RefreshFlagsResponsePB) ProtoMessage()

func (*RefreshFlagsResponsePB) ProtoReflect

func (x *RefreshFlagsResponsePB) ProtoReflect() protoreflect.Message

func (*RefreshFlagsResponsePB) Reset

func (x *RefreshFlagsResponsePB) Reset()

func (*RefreshFlagsResponsePB) String

func (x *RefreshFlagsResponsePB) String() string

func (*RefreshFlagsResponsePB) UnmarshalJSON

func (m *RefreshFlagsResponsePB) UnmarshalJSON(b []byte) error

type ServerClockRequestPB

type ServerClockRequestPB struct {
	// contains filtered or unexported fields
}

Requests the server's current hybrid_time.

func (*ServerClockRequestPB) Descriptor deprecated

func (*ServerClockRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use ServerClockRequestPB.ProtoReflect.Descriptor instead.

func (*ServerClockRequestPB) MarshalJSON

func (m *ServerClockRequestPB) MarshalJSON() ([]byte, error)

func (*ServerClockRequestPB) ProtoMessage

func (*ServerClockRequestPB) ProtoMessage()

func (*ServerClockRequestPB) ProtoReflect

func (x *ServerClockRequestPB) ProtoReflect() protoreflect.Message

func (*ServerClockRequestPB) Reset

func (x *ServerClockRequestPB) Reset()

func (*ServerClockRequestPB) String

func (x *ServerClockRequestPB) String() string

func (*ServerClockRequestPB) UnmarshalJSON

func (m *ServerClockRequestPB) UnmarshalJSON(b []byte) error

type ServerClockResponsePB

type ServerClockResponsePB struct {

	// The current hybrid_time of the server.
	HybridTime *uint64 `protobuf:"fixed64,1,opt,name=hybrid_time,json=hybridTime" json:"hybrid_time,omitempty"`
	// contains filtered or unexported fields
}

func (*ServerClockResponsePB) Descriptor deprecated

func (*ServerClockResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use ServerClockResponsePB.ProtoReflect.Descriptor instead.

func (*ServerClockResponsePB) GetHybridTime

func (x *ServerClockResponsePB) GetHybridTime() uint64

func (*ServerClockResponsePB) MarshalJSON

func (m *ServerClockResponsePB) MarshalJSON() ([]byte, error)

func (*ServerClockResponsePB) ProtoMessage

func (*ServerClockResponsePB) ProtoMessage()

func (*ServerClockResponsePB) ProtoReflect

func (x *ServerClockResponsePB) ProtoReflect() protoreflect.Message

func (*ServerClockResponsePB) Reset

func (x *ServerClockResponsePB) Reset()

func (*ServerClockResponsePB) String

func (x *ServerClockResponsePB) String() string

func (*ServerClockResponsePB) UnmarshalJSON

func (m *ServerClockResponsePB) UnmarshalJSON(b []byte) error

type ServerStatusPB

type ServerStatusPB struct {
	NodeInstance       *common.NodeInstancePB `protobuf:"bytes,1,req,name=node_instance,json=nodeInstance" json:"node_instance,omitempty"`
	BoundRpcAddresses  []*common.HostPortPB   `protobuf:"bytes,2,rep,name=bound_rpc_addresses,json=boundRpcAddresses" json:"bound_rpc_addresses,omitempty"`
	BoundHttpAddresses []*common.HostPortPB   `protobuf:"bytes,3,rep,name=bound_http_addresses,json=boundHttpAddresses" json:"bound_http_addresses,omitempty"`
	VersionInfo        *util.VersionInfoPB    `protobuf:"bytes,4,opt,name=version_info,json=versionInfo" json:"version_info,omitempty"`
	// contains filtered or unexported fields
}

The status information dumped by a server after it starts.

This is optionally exposed on the local host in a text file which the server writes out at startup.

Additionally, it is exposed via RPC through the GenericService interface.

func (*ServerStatusPB) Descriptor deprecated

func (*ServerStatusPB) Descriptor() ([]byte, []int)

Deprecated: Use ServerStatusPB.ProtoReflect.Descriptor instead.

func (*ServerStatusPB) GetBoundHttpAddresses

func (x *ServerStatusPB) GetBoundHttpAddresses() []*common.HostPortPB

func (*ServerStatusPB) GetBoundRpcAddresses

func (x *ServerStatusPB) GetBoundRpcAddresses() []*common.HostPortPB

func (*ServerStatusPB) GetNodeInstance

func (x *ServerStatusPB) GetNodeInstance() *common.NodeInstancePB

func (*ServerStatusPB) GetVersionInfo

func (x *ServerStatusPB) GetVersionInfo() *util.VersionInfoPB

func (*ServerStatusPB) MarshalJSON

func (m *ServerStatusPB) MarshalJSON() ([]byte, error)

func (*ServerStatusPB) ProtoMessage

func (*ServerStatusPB) ProtoMessage()

func (*ServerStatusPB) ProtoReflect

func (x *ServerStatusPB) ProtoReflect() protoreflect.Message

func (*ServerStatusPB) Reset

func (x *ServerStatusPB) Reset()

func (*ServerStatusPB) String

func (x *ServerStatusPB) String() string

func (*ServerStatusPB) UnmarshalJSON

func (m *ServerStatusPB) UnmarshalJSON(b []byte) error

type SetFlagRequestPB

type SetFlagRequestPB struct {
	Flag  *string `protobuf:"bytes,1,req,name=flag" json:"flag,omitempty"`
	Value *string `protobuf:"bytes,2,req,name=value" json:"value,omitempty"`
	// Force the change, even if the flag is not marked as safe to change
	// at runtime. This can cause crashes or other bad behavior, so should
	// only be used as a last resort.
	Force *bool `protobuf:"varint,3,opt,name=force,def=0" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Attempt to set a command line flag. Note that many command line flags do not take effect if changed at runtime.

TODO: We plan to add tags indicating which flags can be modified at runtime. For now, this is an advanced option.

func (*SetFlagRequestPB) Descriptor deprecated

func (*SetFlagRequestPB) Descriptor() ([]byte, []int)

Deprecated: Use SetFlagRequestPB.ProtoReflect.Descriptor instead.

func (*SetFlagRequestPB) GetFlag

func (x *SetFlagRequestPB) GetFlag() string

func (*SetFlagRequestPB) GetForce

func (x *SetFlagRequestPB) GetForce() bool

func (*SetFlagRequestPB) GetValue

func (x *SetFlagRequestPB) GetValue() string

func (*SetFlagRequestPB) MarshalJSON

func (m *SetFlagRequestPB) MarshalJSON() ([]byte, error)

func (*SetFlagRequestPB) ProtoMessage

func (*SetFlagRequestPB) ProtoMessage()

func (*SetFlagRequestPB) ProtoReflect

func (x *SetFlagRequestPB) ProtoReflect() protoreflect.Message

func (*SetFlagRequestPB) Reset

func (x *SetFlagRequestPB) Reset()

func (*SetFlagRequestPB) String

func (x *SetFlagRequestPB) String() string

func (*SetFlagRequestPB) UnmarshalJSON

func (m *SetFlagRequestPB) UnmarshalJSON(b []byte) error

type SetFlagResponsePB

type SetFlagResponsePB struct {
	Result *SetFlagResponsePB_Code `protobuf:"varint,1,req,name=result,enum=yb.server.SetFlagResponsePB_Code" json:"result,omitempty"`
	// A string describing the new value that the option has been set to.
	// This passes through the return value of SetCommandLineOption() from
	// gflags, which doesn't specify anything about the format of this message.
	//
	// Using 'result' above is more reliable.
	Msg *string `protobuf:"bytes,2,opt,name=msg" json:"msg,omitempty"`
	// If the flag exists, the prior value of the flag. This is set even in the
	// case of BAD_VALUE.
	OldValue *string `protobuf:"bytes,3,opt,name=old_value,json=oldValue" json:"old_value,omitempty"`
	// contains filtered or unexported fields
}

func (*SetFlagResponsePB) Descriptor deprecated

func (*SetFlagResponsePB) Descriptor() ([]byte, []int)

Deprecated: Use SetFlagResponsePB.ProtoReflect.Descriptor instead.

func (*SetFlagResponsePB) GetMsg

func (x *SetFlagResponsePB) GetMsg() string

func (*SetFlagResponsePB) GetOldValue

func (x *SetFlagResponsePB) GetOldValue() string

func (*SetFlagResponsePB) GetResult

func (*SetFlagResponsePB) MarshalJSON

func (m *SetFlagResponsePB) MarshalJSON() ([]byte, error)

func (*SetFlagResponsePB) ProtoMessage

func (*SetFlagResponsePB) ProtoMessage()

func (*SetFlagResponsePB) ProtoReflect

func (x *SetFlagResponsePB) ProtoReflect() protoreflect.Message

func (*SetFlagResponsePB) Reset

func (x *SetFlagResponsePB) Reset()

func (*SetFlagResponsePB) String

func (x *SetFlagResponsePB) String() string

func (*SetFlagResponsePB) UnmarshalJSON

func (m *SetFlagResponsePB) UnmarshalJSON(b []byte) error

type SetFlagResponsePB_Code

type SetFlagResponsePB_Code int32
const (
	SetFlagResponsePB_UNKNOWN      SetFlagResponsePB_Code = 0
	SetFlagResponsePB_SUCCESS      SetFlagResponsePB_Code = 1
	SetFlagResponsePB_NO_SUCH_FLAG SetFlagResponsePB_Code = 2
	SetFlagResponsePB_BAD_VALUE    SetFlagResponsePB_Code = 3
	// The flag is not safe to change at runtime without the 'force' flag.
	SetFlagResponsePB_NOT_SAFE SetFlagResponsePB_Code = 4
)

func (SetFlagResponsePB_Code) Descriptor

func (SetFlagResponsePB_Code) Enum

func (SetFlagResponsePB_Code) EnumDescriptor deprecated

func (SetFlagResponsePB_Code) EnumDescriptor() ([]byte, []int)

Deprecated: Use SetFlagResponsePB_Code.Descriptor instead.

func (SetFlagResponsePB_Code) Number

func (SetFlagResponsePB_Code) String

func (x SetFlagResponsePB_Code) String() string

func (SetFlagResponsePB_Code) Type

func (*SetFlagResponsePB_Code) UnmarshalJSON deprecated

func (x *SetFlagResponsePB_Code) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL