Package io.grpc.lb.v1

Interface ServerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Server, Server.Builder

public interface ServerOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Indicates whether this particular request should be dropped by the client.
    com.google.protobuf.ByteString
    A resolved address for the server, serialized in network-byte-order.
    An opaque but printable token for load reporting.
    com.google.protobuf.ByteString
    An opaque but printable token for load reporting.
    int
    A resolved port number for the server.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getIpAddress

      com.google.protobuf.ByteString getIpAddress()
       A resolved address for the server, serialized in network-byte-order. It may
       either be an IPv4 or IPv6 address.
       
      bytes ip_address = 1;
      Returns:
      The ipAddress.
    • getPort

      int getPort()
       A resolved port number for the server.
       
      int32 port = 2;
      Returns:
      The port.
    • getLoadBalanceToken

      String getLoadBalanceToken()
       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.
       
      string load_balance_token = 3;
      Returns:
      The loadBalanceToken.
    • getLoadBalanceTokenBytes

      com.google.protobuf.ByteString getLoadBalanceTokenBytes()
       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.
       
      string load_balance_token = 3;
      Returns:
      The bytes for loadBalanceToken.
    • getDrop

      boolean getDrop()
       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.
       
      bool drop = 4;
      Returns:
      The drop.