package yb.server

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc SetFlag (SetFlagRequestPB, SetFlagResponsePB)

  server_base.proto:168

  message SetFlagRequestPB

  server_base.proto:61

  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.

  • required string flag = 1

  • required string value = 2

  • optional bool force = 3

    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.

  message SetFlagResponsePB

  server_base.proto:71

  • required SetFlagResponsePB.Code result = 1

  • optional string msg = 2

    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.

  • optional string old_value = 3

    If the flag exists, the prior value of the flag. This is set even in the case of BAD_VALUE.

• rpc GetFlag (GetFlagRequestPB, GetFlagResponsePB)

  server_base.proto:171

  message GetFlagRequestPB

  server_base.proto:105

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

  • optional string flag = 1

  message GetFlagResponsePB

  server_base.proto:111

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

  • optional bool valid = 1

  • optional string value = 2

• rpc ValidateFlagValue (ValidateFlagValueRequestPB, ValidateFlagValueResponsePB)

  server_base.proto:174

  message ValidateFlagValueRequestPB

  server_base.proto:158

  • required string flag_name = 1

  • required string flag_value = 2

  message ValidateFlagValueResponsePB

  server_base.proto:163

  RPC will fail on errors.

  (message has no fields)

• rpc RefreshFlags (RefreshFlagsRequestPB, RefreshFlagsResponsePB)

  server_base.proto:177

  message RefreshFlagsRequestPB

  server_base.proto:98

  (message has no fields)

  message RefreshFlagsResponsePB

  server_base.proto:101

  (message has no fields)

• rpc GetAutoFlagsConfigVersion (GetAutoFlagsConfigVersionRequestPB, GetAutoFlagsConfigVersionResponsePB)

  server_base.proto:180

  message GetAutoFlagsConfigVersionRequestPB

  server_base.proto:151

  (message has no fields)

  message GetAutoFlagsConfigVersionResponsePB

  server_base.proto:154

  • required uint32 config_version = 1

• rpc FlushCoverage (FlushCoverageRequestPB, FlushCoverageResponsePB)

  server_base.proto:183

  message FlushCoverageRequestPB

  server_base.proto:117

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

  (message has no fields)

  message FlushCoverageResponsePB

  server_base.proto:119

  • optional bool success = 1

    If the current build is not a coverage build, returns false.

• rpc ServerClock (ServerClockRequestPB, ServerClockResponsePB)

  server_base.proto:186

  message ServerClockRequestPB

  server_base.proto:125

  Requests the server's current hybrid_time.

  (message has no fields)

  message ServerClockResponsePB

  server_base.proto:127

  • optional fixed64 hybrid_time = 1

    The current hybrid_time of the server.

• rpc GetStatus (GetStatusRequestPB, GetStatusResponsePB)

  server_base.proto:189

  message GetStatusRequestPB

  server_base.proto:133

  Requests the server's status and version info

  (message has no fields)

  message GetStatusResponsePB

  server_base.proto:135

  • required ServerStatusPB status = 1

• rpc Ping (PingRequestPB, PingResponsePB)

  server_base.proto:192

  message PingRequestPB

  server_base.proto:139

  (message has no fields)

  message PingResponsePB

  server_base.proto:142

  (message has no fields)

• rpc ReloadCertificates (ReloadCertificatesRequestPB, ReloadCertificatesResponsePB)

  server_base.proto:194

  message ReloadCertificatesRequestPB

  server_base.proto:145

  (message has no fields)

  message ReloadCertificatesResponsePB

  server_base.proto:148

  (message has no 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.

Used in: GetStatusResponsePB

• required NodeInstancePB node_instance = 1

• repeated HostPortPB bound_rpc_addresses = 2

• repeated HostPortPB bound_http_addresses = 3

• optional VersionInfoPB version_info = 4

Used in: SetFlagResponsePB

• UNKNOWN = 0

• SUCCESS = 1

• NO_SUCH_FLAG = 2

• BAD_VALUE = 3

• NOT_SAFE = 4

  The flag is not safe to change at runtime without the 'force' flag.

• PG_SET_FAILED = 5