Package io.grpc.serviceconfig

Interface MethodConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MethodConfig, MethodConfig.Builder
    public interface MethodConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getNameList

        List<MethodConfig.Name> getNameList()
        repeated .grpc.service_config.MethodConfig.Name name = 1;

      • getName

        MethodConfig.Name getName​(int index)
        repeated .grpc.service_config.MethodConfig.Name name = 1;

      • getNameCount

        int getNameCount()
        repeated .grpc.service_config.MethodConfig.Name name = 1;

      • getNameOrBuilder

        MethodConfig.NameOrBuilder getNameOrBuilder​(int index)
        repeated .grpc.service_config.MethodConfig.Name name = 1;

      • hasWaitForReady

        boolean hasWaitForReady()
         Whether RPCs sent to this method should wait until the connection is
 ready by default. If false, the RPC will abort immediately if there is
 a transient failure connecting to the server. Otherwise, gRPC will
 attempt to connect until the deadline is exceeded.
 The value specified via the gRPC client API will override the value
 set here. However, note that setting the value in the client API will
 also affect transient errors encountered during name resolution, which
 cannot be caught by the value here, since the service config is
 obtained by the gRPC client via name resolution.
        .google.protobuf.BoolValue wait_for_ready = 2;
        Returns:
        Whether the waitForReady field is set.

      • getWaitForReady

        com.google.protobuf.BoolValue getWaitForReady()
         Whether RPCs sent to this method should wait until the connection is
 ready by default. If false, the RPC will abort immediately if there is
 a transient failure connecting to the server. Otherwise, gRPC will
 attempt to connect until the deadline is exceeded.
 The value specified via the gRPC client API will override the value
 set here. However, note that setting the value in the client API will
 also affect transient errors encountered during name resolution, which
 cannot be caught by the value here, since the service config is
 obtained by the gRPC client via name resolution.
        .google.protobuf.BoolValue wait_for_ready = 2;
        Returns:
        The waitForReady.

      • getWaitForReadyOrBuilder

        com.google.protobuf.BoolValueOrBuilder getWaitForReadyOrBuilder()
         Whether RPCs sent to this method should wait until the connection is
 ready by default. If false, the RPC will abort immediately if there is
 a transient failure connecting to the server. Otherwise, gRPC will
 attempt to connect until the deadline is exceeded.
 The value specified via the gRPC client API will override the value
 set here. However, note that setting the value in the client API will
 also affect transient errors encountered during name resolution, which
 cannot be caught by the value here, since the service config is
 obtained by the gRPC client via name resolution.
        .google.protobuf.BoolValue wait_for_ready = 2;

      • hasTimeout

        boolean hasTimeout()
         The default timeout in seconds for RPCs sent to this method. This can be
 overridden in code. If no reply is received in the specified amount of
 time, the request is aborted and a DEADLINE_EXCEEDED error status
 is returned to the caller.
 The actual deadline used will be the minimum of the value specified here
 and the value set by the application via the gRPC client API.  If either
 one is not set, then the other will be used.  If neither is set, then the
 request has no deadline.
        .google.protobuf.Duration timeout = 3;
        Returns:
        Whether the timeout field is set.

      • getTimeout

        com.google.protobuf.Duration getTimeout()
         The default timeout in seconds for RPCs sent to this method. This can be
 overridden in code. If no reply is received in the specified amount of
 time, the request is aborted and a DEADLINE_EXCEEDED error status
 is returned to the caller.
 The actual deadline used will be the minimum of the value specified here
 and the value set by the application via the gRPC client API.  If either
 one is not set, then the other will be used.  If neither is set, then the
 request has no deadline.
        .google.protobuf.Duration timeout = 3;
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         The default timeout in seconds for RPCs sent to this method. This can be
 overridden in code. If no reply is received in the specified amount of
 time, the request is aborted and a DEADLINE_EXCEEDED error status
 is returned to the caller.
 The actual deadline used will be the minimum of the value specified here
 and the value set by the application via the gRPC client API.  If either
 one is not set, then the other will be used.  If neither is set, then the
 request has no deadline.
        .google.protobuf.Duration timeout = 3;

      • hasMaxRequestMessageBytes

        boolean hasMaxRequestMessageBytes()
         The maximum allowed payload size for an individual request or object in a
 stream (client->server) in bytes. The size which is measured is the
 serialized payload after per-message compression (but before stream
 compression) in bytes. This applies both to streaming and non-streaming
 requests.
 The actual value used is the minimum of the value specified here and the
 value set by the application via the gRPC client API.  If either one is
 not set, then the other will be used.  If neither is set, then the
 built-in default is used.
 If a client attempts to send an object larger than this value, it will not
 be sent and the client will see a ClientError.
 Note that 0 is a valid value, meaning that the request message
 must be empty.
        .google.protobuf.UInt32Value max_request_message_bytes = 4;
        Returns:
        Whether the maxRequestMessageBytes field is set.

      • getMaxRequestMessageBytes

        com.google.protobuf.UInt32Value getMaxRequestMessageBytes()
         The maximum allowed payload size for an individual request or object in a
 stream (client->server) in bytes. The size which is measured is the
 serialized payload after per-message compression (but before stream
 compression) in bytes. This applies both to streaming and non-streaming
 requests.
 The actual value used is the minimum of the value specified here and the
 value set by the application via the gRPC client API.  If either one is
 not set, then the other will be used.  If neither is set, then the
 built-in default is used.
 If a client attempts to send an object larger than this value, it will not
 be sent and the client will see a ClientError.
 Note that 0 is a valid value, meaning that the request message
 must be empty.
        .google.protobuf.UInt32Value max_request_message_bytes = 4;
        Returns:
        The maxRequestMessageBytes.

      • getMaxRequestMessageBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxRequestMessageBytesOrBuilder()
         The maximum allowed payload size for an individual request or object in a
 stream (client->server) in bytes. The size which is measured is the
 serialized payload after per-message compression (but before stream
 compression) in bytes. This applies both to streaming and non-streaming
 requests.
 The actual value used is the minimum of the value specified here and the
 value set by the application via the gRPC client API.  If either one is
 not set, then the other will be used.  If neither is set, then the
 built-in default is used.
 If a client attempts to send an object larger than this value, it will not
 be sent and the client will see a ClientError.
 Note that 0 is a valid value, meaning that the request message
 must be empty.
        .google.protobuf.UInt32Value max_request_message_bytes = 4;

      • hasMaxResponseMessageBytes

        boolean hasMaxResponseMessageBytes()
         The maximum allowed payload size for an individual response or object in a
 stream (server->client) in bytes. The size which is measured is the
 serialized payload after per-message compression (but before stream
 compression) in bytes. This applies both to streaming and non-streaming
 requests.
 The actual value used is the minimum of the value specified here and the
 value set by the application via the gRPC client API.  If either one is
 not set, then the other will be used.  If neither is set, then the
 built-in default is used.
 If a server attempts to send an object larger than this value, it will not
 be sent, and a ServerError will be sent to the client instead.
 Note that 0 is a valid value, meaning that the response message
 must be empty.
        .google.protobuf.UInt32Value max_response_message_bytes = 5;
        Returns:
        Whether the maxResponseMessageBytes field is set.

      • getMaxResponseMessageBytes

        com.google.protobuf.UInt32Value getMaxResponseMessageBytes()
         The maximum allowed payload size for an individual response or object in a
 stream (server->client) in bytes. The size which is measured is the
 serialized payload after per-message compression (but before stream
 compression) in bytes. This applies both to streaming and non-streaming
 requests.
 The actual value used is the minimum of the value specified here and the
 value set by the application via the gRPC client API.  If either one is
 not set, then the other will be used.  If neither is set, then the
 built-in default is used.
 If a server attempts to send an object larger than this value, it will not
 be sent, and a ServerError will be sent to the client instead.
 Note that 0 is a valid value, meaning that the response message
 must be empty.
        .google.protobuf.UInt32Value max_response_message_bytes = 5;
        Returns:
        The maxResponseMessageBytes.

      • getMaxResponseMessageBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getMaxResponseMessageBytesOrBuilder()
         The maximum allowed payload size for an individual response or object in a
 stream (server->client) in bytes. The size which is measured is the
 serialized payload after per-message compression (but before stream
 compression) in bytes. This applies both to streaming and non-streaming
 requests.
 The actual value used is the minimum of the value specified here and the
 value set by the application via the gRPC client API.  If either one is
 not set, then the other will be used.  If neither is set, then the
 built-in default is used.
 If a server attempts to send an object larger than this value, it will not
 be sent, and a ServerError will be sent to the client instead.
 Note that 0 is a valid value, meaning that the response message
 must be empty.
        .google.protobuf.UInt32Value max_response_message_bytes = 5;

      • hasRetryPolicy

        boolean hasRetryPolicy()
        .grpc.service_config.MethodConfig.RetryPolicy retry_policy = 6;
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        MethodConfig.RetryPolicy getRetryPolicy()
        .grpc.service_config.MethodConfig.RetryPolicy retry_policy = 6;
        Returns:
        The retryPolicy.

      • hasHedgingPolicy

        boolean hasHedgingPolicy()
        .grpc.service_config.MethodConfig.HedgingPolicy hedging_policy = 7;
        Returns:
        Whether the hedgingPolicy field is set.

      • getHedgingPolicy

        MethodConfig.HedgingPolicy getHedgingPolicy()
        .grpc.service_config.MethodConfig.HedgingPolicy hedging_policy = 7;
        Returns:
        The hedgingPolicy.