Package io.envoyproxy.envoy.config.core.v3

Interface GrpcServiceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GrpcService, GrpcService.Builder
public interface GrpcServiceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasEnvoyGrpc

      boolean hasEnvoyGrpc()
       Envoy's in-built gRPC client.
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
      .envoy.config.core.v3.GrpcService.EnvoyGrpc envoy_grpc = 1;
      Returns:
      Whether the envoyGrpc field is set.

    • getEnvoyGrpc

      GrpcService.EnvoyGrpc getEnvoyGrpc()
       Envoy's in-built gRPC client.
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
      .envoy.config.core.v3.GrpcService.EnvoyGrpc envoy_grpc = 1;
      Returns:
      The envoyGrpc.

    • getEnvoyGrpcOrBuilder

      GrpcService.EnvoyGrpcOrBuilder getEnvoyGrpcOrBuilder()
       Envoy's in-built gRPC client.
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
      .envoy.config.core.v3.GrpcService.EnvoyGrpc envoy_grpc = 1;

    • hasGoogleGrpc

      boolean hasGoogleGrpc()
       `Google C++ gRPC client <https://github.com/grpc/grpc>`_
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
      .envoy.config.core.v3.GrpcService.GoogleGrpc google_grpc = 2;
      Returns:
      Whether the googleGrpc field is set.

    • getGoogleGrpc

      GrpcService.GoogleGrpc getGoogleGrpc()
       `Google C++ gRPC client <https://github.com/grpc/grpc>`_
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
      .envoy.config.core.v3.GrpcService.GoogleGrpc google_grpc = 2;
      Returns:
      The googleGrpc.

    • getGoogleGrpcOrBuilder

      GrpcService.GoogleGrpcOrBuilder getGoogleGrpcOrBuilder()
       `Google C++ gRPC client <https://github.com/grpc/grpc>`_
 See the :ref:`gRPC services overview <arch_overview_grpc_services>`
 documentation for discussion on gRPC client selection.
      .envoy.config.core.v3.GrpcService.GoogleGrpc google_grpc = 2;

    • hasTimeout

      boolean hasTimeout()
       The timeout for the gRPC request. This is the timeout for a specific
 request.
      .google.protobuf.Duration timeout = 3;
      Returns:
      Whether the timeout field is set.

    • getTimeout

      com.google.protobuf.Duration getTimeout()
       The timeout for the gRPC request. This is the timeout for a specific
 request.
      .google.protobuf.Duration timeout = 3;
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       The timeout for the gRPC request. This is the timeout for a specific
 request.
      .google.protobuf.Duration timeout = 3;

    • getInitialMetadataList

      List<HeaderValue> getInitialMetadataList()
       Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;

    • getInitialMetadata

      HeaderValue getInitialMetadata(int index)
       Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;

    • getInitialMetadataCount

      int getInitialMetadataCount()
       Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;

    • getInitialMetadataOrBuilderList

      List<? extends HeaderValueOrBuilder> getInitialMetadataOrBuilderList()
       Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;

    • getInitialMetadataOrBuilder

      HeaderValueOrBuilder getInitialMetadataOrBuilder(int index)
       Additional metadata to include in streams initiated to the GrpcService. This can be used for
 scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
 be injected. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.core.v3.HeaderValue initial_metadata = 5;

    • hasRetryPolicy

      boolean hasRetryPolicy()
       Optional default retry policy for RPCs or streams initiated toward this gRPC service.

 If an async stream does not have a retry policy configured in its per‑stream options, this
 policy is used as the default.

 .. note::

   This field is only applied by Envoy gRPC (``envoy_grpc``) clients. Google gRPC
   (``google_grpc``) clients currently ignore this field.

 If not specified, no default retry policy is applied at the client level and retries only occur
 when explicitly configured in per‑stream options.
      .envoy.config.core.v3.RetryPolicy retry_policy = 6;
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      RetryPolicy getRetryPolicy()
       Optional default retry policy for RPCs or streams initiated toward this gRPC service.

 If an async stream does not have a retry policy configured in its per‑stream options, this
 policy is used as the default.

 .. note::

   This field is only applied by Envoy gRPC (``envoy_grpc``) clients. Google gRPC
   (``google_grpc``) clients currently ignore this field.

 If not specified, no default retry policy is applied at the client level and retries only occur
 when explicitly configured in per‑stream options.
      .envoy.config.core.v3.RetryPolicy retry_policy = 6;
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       Optional default retry policy for RPCs or streams initiated toward this gRPC service.

 If an async stream does not have a retry policy configured in its per‑stream options, this
 policy is used as the default.

 .. note::

   This field is only applied by Envoy gRPC (``envoy_grpc``) clients. Google gRPC
   (``google_grpc``) clients currently ignore this field.

 If not specified, no default retry policy is applied at the client level and retries only occur
 when explicitly configured in per‑stream options.
      .envoy.config.core.v3.RetryPolicy retry_policy = 6;

    • getTargetSpecifierCase

      GrpcService.TargetSpecifierCase getTargetSpecifierCase()