package load_balancer
- Alphabetic
- Public
- Protected
Type Members
- final case class ClientStats(timestamp: Option[Timestamp] = _root_.scala.None, numCallsStarted: Long = 0L, numCallsFinished: Long = 0L, numCallsFinishedWithClientFailedToSend: Long = 0L, numCallsFinishedKnownReceived: Long = 0L, callsFinishedWithDrop: Seq[ClientStatsPerToken] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ClientStats] with Product with Serializable
Contains client level statistics that are useful to load balancing.
Contains client level statistics that are useful to load balancing. Each count except the timestamp should be reset to zero after reporting the stats.
- timestamp
The timestamp of generating the report.
- numCallsStarted
The total number of RPCs that started.
- numCallsFinished
The total number of RPCs that finished.
- numCallsFinishedWithClientFailedToSend
The total number of RPCs that failed to reach a server except dropped RPCs.
- numCallsFinishedKnownReceived
The total number of RPCs that finished and are known to have been received by a server.
- callsFinishedWithDrop
The list of dropped calls.
- Annotations
- @SerialVersionUID()
- final case class ClientStatsPerToken(loadBalanceToken: String = "", numCalls: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ClientStatsPerToken] with Product with Serializable
Contains the number of calls finished for a particular load balance token.
Contains the number of calls finished for a particular load balance token.
- loadBalanceToken
See Server.load_balance_token.
- numCalls
The total number of RPCs that finished associated with the token.
- Annotations
- @SerialVersionUID()
- final case class FallbackResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FallbackResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class InitialLoadBalanceRequest(name: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InitialLoadBalanceRequest] with Product with Serializable
- name
The name of the load balanced service (e.g., service.googleapis.com). Its length should be less than 256 bytes. The name might include a port number. How to handle the port number is up to the balancer.
- Annotations
- @SerialVersionUID()
- final case class InitialLoadBalanceResponse(loadBalancerDelegate: String = "", clientStatsReportInterval: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InitialLoadBalanceResponse] with Product with Serializable
- loadBalancerDelegate
This is an application layer redirect that indicates the client should use the specified server for load balancing. When this field is non-empty in the response, the client should open a separate connection to the load_balancer_delegate and call the BalanceLoad method. Its length should be less than 64 bytes.
- clientStatsReportInterval
This interval defines how often the client should send the client stats to the load balancer. Stats should only be reported when the duration is positive.
- Annotations
- @SerialVersionUID()
- final case class LoadBalanceRequest(loadBalanceRequestType: LoadBalanceRequestType = io.grpc.lb.v1.load_balancer.LoadBalanceRequest.LoadBalanceRequestType.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LoadBalanceRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class LoadBalanceResponse(loadBalanceResponseType: LoadBalanceResponseType = io.grpc.lb.v1.load_balancer.LoadBalanceResponse.LoadBalanceResponseType.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LoadBalanceResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- trait LoadBalancer extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- trait LoadBalancerClient extends LoadBalancer with LoadBalancerClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait LoadBalancerClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- final case class Server(ipAddress: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, port: Int = 0, loadBalanceToken: String = "", drop: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Server] with Product with Serializable
Contains server information.
Contains server information. When the drop field is not true, use the other fields.
- ipAddress
A resolved address for the server, serialized in network-byte-order. It may either be an IPv4 or IPv6 address.
- port
A resolved port number for the server.
- loadBalanceToken
An opaque but printable token for load reporting. The client must include the token of the picked server into the initial metadata when it starts a call to that server. The token is used by the server to verify the request and to allow the server to report load to the gRPC LB system. The token is also used in client stats for reporting dropped calls. Its length can be variable but must be less than 50 bytes.
- drop
Indicates whether this particular request should be dropped by the client. If the request is dropped, there will be a corresponding entry in ClientStats.calls_finished_with_drop.
- Annotations
- @SerialVersionUID()
- final case class ServerList(servers: Seq[Server] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ServerList] with Product with Serializable
- servers
Contains a list of servers selected by the load balancer. The list will be updated when server resolutions change or as needed to balance load across more servers. The client should consume the server list in order unless instructed otherwise via the client_config.
- Annotations
- @SerialVersionUID()
Value Members
- object ClientStats extends GeneratedMessageCompanion[ClientStats]
- object ClientStatsPerToken extends GeneratedMessageCompanion[ClientStatsPerToken]
- object FallbackResponse extends GeneratedMessageCompanion[FallbackResponse]
- object InitialLoadBalanceRequest extends GeneratedMessageCompanion[InitialLoadBalanceRequest]
- object InitialLoadBalanceResponse extends GeneratedMessageCompanion[InitialLoadBalanceResponse]
- object LoadBalanceRequest extends GeneratedMessageCompanion[LoadBalanceRequest]
- object LoadBalanceResponse extends GeneratedMessageCompanion[LoadBalanceResponse]
- object LoadBalancer extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object LoadBalancerClient
- Annotations
- @PekkoGrpcGenerated()
- object LoadBalancerProto extends GeneratedFileObject
- object Server extends GeneratedMessageCompanion[Server]
- object ServerList extends GeneratedMessageCompanion[ServerList]