Class GrpcService.EnvoyGrpc.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<GrpcService.EnvoyGrpc.Builder>
com.google.protobuf.GeneratedMessage.Builder<GrpcService.EnvoyGrpc.Builder>
io.envoyproxy.envoy.config.core.v3.GrpcService.EnvoyGrpc.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GrpcService.EnvoyGrpcOrBuilder, Cloneable
Enclosing class:
GrpcService.EnvoyGrpc
public static final class GrpcService.EnvoyGrpc.Builder extends com.google.protobuf.GeneratedMessage.Builder<GrpcService.EnvoyGrpc.Builder> implements GrpcService.EnvoyGrpcOrBuilder
[#next-free-field: 6]
Protobuf type envoy.config.core.v3.GrpcService.EnvoyGrpc

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GrpcService.EnvoyGrpc.Builder>

    • clear

      public GrpcService.EnvoyGrpc.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<GrpcService.EnvoyGrpc.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GrpcService.EnvoyGrpc.Builder>

    • getDefaultInstanceForType

      public GrpcService.EnvoyGrpc getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public GrpcService.EnvoyGrpc build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public GrpcService.EnvoyGrpc buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public GrpcService.EnvoyGrpc.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GrpcService.EnvoyGrpc.Builder>

    • mergeFrom

      public GrpcService.EnvoyGrpc.Builder mergeFrom(GrpcService.EnvoyGrpc other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GrpcService.EnvoyGrpc.Builder>

    • mergeFrom

      public GrpcService.EnvoyGrpc.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GrpcService.EnvoyGrpc.Builder>
      Throws:
      IOException

    • getClusterName

      public 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) = { ... }
      Specified by:
      getClusterName in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The clusterName.

    • getClusterNameBytes

      public 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) = { ... }
      Specified by:
      getClusterNameBytes in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The bytes for clusterName.

    • setClusterName

      public GrpcService.EnvoyGrpc.Builder setClusterName(String value)
      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) = { ... }
      Parameters:
      value - The clusterName to set.
      Returns:
      This builder for chaining.

    • clearClusterName

      public GrpcService.EnvoyGrpc.Builder clearClusterName()
      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:
      This builder for chaining.

    • setClusterNameBytes

      public GrpcService.EnvoyGrpc.Builder setClusterNameBytes(com.google.protobuf.ByteString value)
      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) = { ... }
      Parameters:
      value - The bytes for clusterName to set.
      Returns:
      This builder for chaining.

    • getAuthority

      public 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) = { ... }
      Specified by:
      getAuthority in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The authority.

    • getAuthorityBytes

      public 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) = { ... }
      Specified by:
      getAuthorityBytes in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The bytes for authority.

    • setAuthority

      public GrpcService.EnvoyGrpc.Builder setAuthority(String value)
      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) = { ... }
      Parameters:
      value - The authority to set.
      Returns:
      This builder for chaining.

    • clearAuthority

      public GrpcService.EnvoyGrpc.Builder clearAuthority()
      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:
      This builder for chaining.

    • setAuthorityBytes

      public GrpcService.EnvoyGrpc.Builder setAuthorityBytes(com.google.protobuf.ByteString value)
      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) = { ... }
      Parameters:
      value - The bytes for authority to set.
      Returns:
      This builder for chaining.

    • hasRetryPolicy

      public 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;
      Specified by:
      hasRetryPolicy in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      public 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;
      Specified by:
      getRetryPolicy in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The retryPolicy.

    • setRetryPolicy

      public GrpcService.EnvoyGrpc.Builder setRetryPolicy(RetryPolicy value)
      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;

    • setRetryPolicy

      public GrpcService.EnvoyGrpc.Builder setRetryPolicy(RetryPolicy.Builder builderForValue)
      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;

    • mergeRetryPolicy

      public GrpcService.EnvoyGrpc.Builder mergeRetryPolicy(RetryPolicy value)
      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;

    • clearRetryPolicy

      public GrpcService.EnvoyGrpc.Builder clearRetryPolicy()
      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;

    • getRetryPolicyBuilder

      public RetryPolicy.Builder getRetryPolicyBuilder()
      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;

    • getRetryPolicyOrBuilder

      public 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;
      Specified by:
      getRetryPolicyOrBuilder in interface GrpcService.EnvoyGrpcOrBuilder

    • hasMaxReceiveMessageLength

      public 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;
      Specified by:
      hasMaxReceiveMessageLength in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      Whether the maxReceiveMessageLength field is set.

    • getMaxReceiveMessageLength

      public 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;
      Specified by:
      getMaxReceiveMessageLength in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The maxReceiveMessageLength.

    • setMaxReceiveMessageLength

      public GrpcService.EnvoyGrpc.Builder setMaxReceiveMessageLength(com.google.protobuf.UInt32Value value)
      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;

    • setMaxReceiveMessageLength

      public GrpcService.EnvoyGrpc.Builder setMaxReceiveMessageLength(com.google.protobuf.UInt32Value.Builder builderForValue)
      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;

    • mergeMaxReceiveMessageLength

      public GrpcService.EnvoyGrpc.Builder mergeMaxReceiveMessageLength(com.google.protobuf.UInt32Value value)
      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;

    • clearMaxReceiveMessageLength

      public GrpcService.EnvoyGrpc.Builder clearMaxReceiveMessageLength()
      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;

    • getMaxReceiveMessageLengthBuilder

      public com.google.protobuf.UInt32Value.Builder getMaxReceiveMessageLengthBuilder()
      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;

    • getMaxReceiveMessageLengthOrBuilder

      public 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;
      Specified by:
      getMaxReceiveMessageLengthOrBuilder in interface GrpcService.EnvoyGrpcOrBuilder

    • getSkipEnvoyHeaders

      public 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;
      Specified by:
      getSkipEnvoyHeaders in interface GrpcService.EnvoyGrpcOrBuilder
      Returns:
      The skipEnvoyHeaders.

    • setSkipEnvoyHeaders

      public GrpcService.EnvoyGrpc.Builder setSkipEnvoyHeaders(boolean value)
      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;
      Parameters:
      value - The skipEnvoyHeaders to set.
      Returns:
      This builder for chaining.

    • clearSkipEnvoyHeaders

      public GrpcService.EnvoyGrpc.Builder clearSkipEnvoyHeaders()
      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:
      This builder for chaining.