Interface GrpcService.EnvoyGrpcOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GrpcService.EnvoyGrpc, GrpcService.EnvoyGrpc.Builder
Enclosing class:
GrpcService

public static interface GrpcService.EnvoyGrpcOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    The ``:authority`` header in the grpc request.
    com.google.protobuf.ByteString
    The ``:authority`` header in the grpc request.
    The name of the upstream gRPC cluster.
    com.google.protobuf.ByteString
    The name of the upstream gRPC cluster.
    com.google.protobuf.UInt32Value
    Maximum gRPC message size that is allowed to be received.
    com.google.protobuf.UInt32ValueOrBuilder
    Maximum gRPC message size that is allowed to be received.
    Indicates the retry policy for re-establishing the gRPC stream This field is optional.
    Indicates the retry policy for re-establishing the gRPC stream This field is optional.
    boolean
    This provides gRPC client level control over envoy generated headers.
    boolean
    Maximum gRPC message size that is allowed to be received.
    boolean
    Indicates the retry policy for re-establishing the gRPC stream This field is optional.

    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

    • getClusterName

      String getClusterName()
       The name of the upstream gRPC cluster. SSL credentials will be supplied
       in the :ref:`Cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` :ref:`transport_socket
       <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`.
       
      string cluster_name = 1 [(.validate.rules) = { ... }
      Returns:
      The clusterName.
    • getClusterNameBytes

      com.google.protobuf.ByteString getClusterNameBytes()
       The name of the upstream gRPC cluster. SSL credentials will be supplied
       in the :ref:`Cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` :ref:`transport_socket
       <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`.
       
      string cluster_name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for clusterName.
    • getAuthority

      String getAuthority()
       The ``:authority`` header in the grpc request. If this field is not set, the authority header value will be ``cluster_name``.
       Note that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.
       
      string authority = 2 [(.validate.rules) = { ... }
      Returns:
      The authority.
    • getAuthorityBytes

      com.google.protobuf.ByteString getAuthorityBytes()
       The ``:authority`` header in the grpc request. If this field is not set, the authority header value will be ``cluster_name``.
       Note that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.
       
      string authority = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for authority.
    • hasRetryPolicy

      boolean hasRetryPolicy()
       Indicates the retry policy for re-establishing the gRPC stream
       This field is optional. If max interval is not provided, it will be set to ten times the provided base interval.
       Currently only supported for xDS gRPC streams.
       If not set, xDS gRPC streams default base interval:500ms, maximum interval:30s will be applied.
       
      .envoy.config.core.v3.RetryPolicy retry_policy = 3;
      Returns:
      Whether the retryPolicy field is set.
    • getRetryPolicy

      RetryPolicy getRetryPolicy()
       Indicates the retry policy for re-establishing the gRPC stream
       This field is optional. If max interval is not provided, it will be set to ten times the provided base interval.
       Currently only supported for xDS gRPC streams.
       If not set, xDS gRPC streams default base interval:500ms, maximum interval:30s will be applied.
       
      .envoy.config.core.v3.RetryPolicy retry_policy = 3;
      Returns:
      The retryPolicy.
    • getRetryPolicyOrBuilder

      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       Indicates the retry policy for re-establishing the gRPC stream
       This field is optional. If max interval is not provided, it will be set to ten times the provided base interval.
       Currently only supported for xDS gRPC streams.
       If not set, xDS gRPC streams default base interval:500ms, maximum interval:30s will be applied.
       
      .envoy.config.core.v3.RetryPolicy retry_policy = 3;
    • hasMaxReceiveMessageLength

      boolean hasMaxReceiveMessageLength()
       Maximum gRPC message size that is allowed to be received.
       If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.
       This limit is applied to individual messages in the streaming response and not the total size of streaming response.
       Defaults to 0, which means unlimited.
       
      .google.protobuf.UInt32Value max_receive_message_length = 4;
      Returns:
      Whether the maxReceiveMessageLength field is set.
    • getMaxReceiveMessageLength

      com.google.protobuf.UInt32Value getMaxReceiveMessageLength()
       Maximum gRPC message size that is allowed to be received.
       If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.
       This limit is applied to individual messages in the streaming response and not the total size of streaming response.
       Defaults to 0, which means unlimited.
       
      .google.protobuf.UInt32Value max_receive_message_length = 4;
      Returns:
      The maxReceiveMessageLength.
    • getMaxReceiveMessageLengthOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxReceiveMessageLengthOrBuilder()
       Maximum gRPC message size that is allowed to be received.
       If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.
       This limit is applied to individual messages in the streaming response and not the total size of streaming response.
       Defaults to 0, which means unlimited.
       
      .google.protobuf.UInt32Value max_receive_message_length = 4;
    • getSkipEnvoyHeaders

      boolean getSkipEnvoyHeaders()
       This provides gRPC client level control over envoy generated headers.
       If false, the header will be sent but it can be overridden by per stream option.
       If true, the header will be removed and can not be overridden by per stream option.
       Default to false.
       
      bool skip_envoy_headers = 5;
      Returns:
      The skipEnvoyHeaders.