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

Interface GrpcService.GoogleGrpcOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GrpcService.GoogleGrpc, GrpcService.GoogleGrpc.Builder
Enclosing class:
GrpcService
public static interface GrpcService.GoogleGrpcOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getTargetUri

      String getTargetUri()
       The target URI when using the `Google C++ gRPC client
 <https://github.com/grpc/grpc>`_.
      string target_uri = 1 [(.validate.rules) = { ... }
      Returns:
      The targetUri.

    • getTargetUriBytes

      com.google.protobuf.ByteString getTargetUriBytes()
       The target URI when using the `Google C++ gRPC client
 <https://github.com/grpc/grpc>`_.
      string target_uri = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for targetUri.

    • hasChannelCredentials

      boolean hasChannelCredentials()
       The channel credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``channel_credentials_plugin`` is set.
      .envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelCredentials channel_credentials = 2;
      Returns:
      Whether the channelCredentials field is set.

    • getChannelCredentials

      GrpcService.GoogleGrpc.ChannelCredentials getChannelCredentials()
       The channel credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``channel_credentials_plugin`` is set.
      .envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelCredentials channel_credentials = 2;
      Returns:
      The channelCredentials.

    • getChannelCredentialsOrBuilder

      GrpcService.GoogleGrpc.ChannelCredentialsOrBuilder getChannelCredentialsOrBuilder()
       The channel credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``channel_credentials_plugin`` is set.
      .envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelCredentials channel_credentials = 2;

    • getChannelCredentialsPluginList

      List<com.google.protobuf.Any> getChannelCredentialsPluginList()
       A list of channel credentials plugins.
 The data plane will iterate over the list in order and stop at the first credential type
 that it supports. This provides a mechanism for starting to use new credential types that
 are not yet supported by all data planes.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any channel_credentials_plugin = 9;

    • getChannelCredentialsPlugin

      com.google.protobuf.Any getChannelCredentialsPlugin(int index)
       A list of channel credentials plugins.
 The data plane will iterate over the list in order and stop at the first credential type
 that it supports. This provides a mechanism for starting to use new credential types that
 are not yet supported by all data planes.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any channel_credentials_plugin = 9;

    • getChannelCredentialsPluginCount

      int getChannelCredentialsPluginCount()
       A list of channel credentials plugins.
 The data plane will iterate over the list in order and stop at the first credential type
 that it supports. This provides a mechanism for starting to use new credential types that
 are not yet supported by all data planes.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any channel_credentials_plugin = 9;

    • getChannelCredentialsPluginOrBuilderList

      List<? extends com.google.protobuf.AnyOrBuilder> getChannelCredentialsPluginOrBuilderList()
       A list of channel credentials plugins.
 The data plane will iterate over the list in order and stop at the first credential type
 that it supports. This provides a mechanism for starting to use new credential types that
 are not yet supported by all data planes.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any channel_credentials_plugin = 9;

    • getChannelCredentialsPluginOrBuilder

      com.google.protobuf.AnyOrBuilder getChannelCredentialsPluginOrBuilder(int index)
       A list of channel credentials plugins.
 The data plane will iterate over the list in order and stop at the first credential type
 that it supports. This provides a mechanism for starting to use new credential types that
 are not yet supported by all data planes.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any channel_credentials_plugin = 9;

    • getCallCredentialsList

      List<GrpcService.GoogleGrpc.CallCredentials> getCallCredentialsList()
       The call credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``call_credentials_plugin`` is set.
      repeated .envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials call_credentials = 3;

    • getCallCredentials

      GrpcService.GoogleGrpc.CallCredentials getCallCredentials(int index)
       The call credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``call_credentials_plugin`` is set.
      repeated .envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials call_credentials = 3;

    • getCallCredentialsCount

      int getCallCredentialsCount()
       The call credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``call_credentials_plugin`` is set.
      repeated .envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials call_credentials = 3;

    • getCallCredentialsOrBuilderList

      List<? extends GrpcService.GoogleGrpc.CallCredentialsOrBuilder> getCallCredentialsOrBuilderList()
       The call credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``call_credentials_plugin`` is set.
      repeated .envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials call_credentials = 3;

    • getCallCredentialsOrBuilder

      GrpcService.GoogleGrpc.CallCredentialsOrBuilder getCallCredentialsOrBuilder(int index)
       The call credentials to use. See `channel credentials
 <https://grpc.io/docs/guides/auth.html#credential-types>`_.
 Ignored if ``call_credentials_plugin`` is set.
      repeated .envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials call_credentials = 3;

    • getCallCredentialsPluginList

      List<com.google.protobuf.Any> getCallCredentialsPluginList()
       A list of call credentials plugins. All supported plugins will be used.
 Unsupported plugin types will be ignored.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any call_credentials_plugin = 10;

    • getCallCredentialsPlugin

      com.google.protobuf.Any getCallCredentialsPlugin(int index)
       A list of call credentials plugins. All supported plugins will be used.
 Unsupported plugin types will be ignored.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any call_credentials_plugin = 10;

    • getCallCredentialsPluginCount

      int getCallCredentialsPluginCount()
       A list of call credentials plugins. All supported plugins will be used.
 Unsupported plugin types will be ignored.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any call_credentials_plugin = 10;

    • getCallCredentialsPluginOrBuilderList

      List<? extends com.google.protobuf.AnyOrBuilder> getCallCredentialsPluginOrBuilderList()
       A list of call credentials plugins. All supported plugins will be used.
 Unsupported plugin types will be ignored.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any call_credentials_plugin = 10;

    • getCallCredentialsPluginOrBuilder

      com.google.protobuf.AnyOrBuilder getCallCredentialsPluginOrBuilder(int index)
       A list of call credentials plugins. All supported plugins will be used.
 Unsupported plugin types will be ignored.
 [#not-implemented-hide:]
      repeated .google.protobuf.Any call_credentials_plugin = 10;

    • getStatPrefix

      String getStatPrefix()
       The human readable prefix to use when emitting statistics for the gRPC
 service.

 .. csv-table::
    :header: Name, Type, Description
    :widths: 1, 1, 2

    streams_total, Counter, Total number of streams opened
    streams_closed_<gRPC status code>, Counter, Total streams closed with <gRPC status code>
      string stat_prefix = 4 [(.validate.rules) = { ... }
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
       The human readable prefix to use when emitting statistics for the gRPC
 service.

 .. csv-table::
    :header: Name, Type, Description
    :widths: 1, 1, 2

    streams_total, Counter, Total number of streams opened
    streams_closed_<gRPC status code>, Counter, Total streams closed with <gRPC status code>
      string stat_prefix = 4 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • getCredentialsFactoryName

      String getCredentialsFactoryName()
       The name of the Google gRPC credentials factory to use. This must have been registered with
 Envoy. If this is empty, a default credentials factory will be used that sets up channel
 credentials based on other configuration parameters.
      string credentials_factory_name = 5;
      Returns:
      The credentialsFactoryName.

    • getCredentialsFactoryNameBytes

      com.google.protobuf.ByteString getCredentialsFactoryNameBytes()
       The name of the Google gRPC credentials factory to use. This must have been registered with
 Envoy. If this is empty, a default credentials factory will be used that sets up channel
 credentials based on other configuration parameters.
      string credentials_factory_name = 5;
      Returns:
      The bytes for credentialsFactoryName.

    • hasConfig

      boolean hasConfig()
       Additional configuration for site-specific customizations of the Google
 gRPC library.
      .google.protobuf.Struct config = 6;
      Returns:
      Whether the config field is set.

    • getConfig

      com.google.protobuf.Struct getConfig()
       Additional configuration for site-specific customizations of the Google
 gRPC library.
      .google.protobuf.Struct config = 6;
      Returns:
      The config.

    • getConfigOrBuilder

      com.google.protobuf.StructOrBuilder getConfigOrBuilder()
       Additional configuration for site-specific customizations of the Google
 gRPC library.
      .google.protobuf.Struct config = 6;

    • hasPerStreamBufferLimitBytes

      boolean hasPerStreamBufferLimitBytes()
       How many bytes each stream can buffer internally.
 If not set an implementation defined default is applied (1MiB).
      .google.protobuf.UInt32Value per_stream_buffer_limit_bytes = 7;
      Returns:
      Whether the perStreamBufferLimitBytes field is set.

    • getPerStreamBufferLimitBytes

      com.google.protobuf.UInt32Value getPerStreamBufferLimitBytes()
       How many bytes each stream can buffer internally.
 If not set an implementation defined default is applied (1MiB).
      .google.protobuf.UInt32Value per_stream_buffer_limit_bytes = 7;
      Returns:
      The perStreamBufferLimitBytes.

    • getPerStreamBufferLimitBytesOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getPerStreamBufferLimitBytesOrBuilder()
       How many bytes each stream can buffer internally.
 If not set an implementation defined default is applied (1MiB).
      .google.protobuf.UInt32Value per_stream_buffer_limit_bytes = 7;

    • hasChannelArgs

      boolean hasChannelArgs()
       Custom channels args.
      .envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs channel_args = 8;
      Returns:
      Whether the channelArgs field is set.

    • getChannelArgs

      GrpcService.GoogleGrpc.ChannelArgs getChannelArgs()
       Custom channels args.
      .envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs channel_args = 8;
      Returns:
      The channelArgs.

    • getChannelArgsOrBuilder

      GrpcService.GoogleGrpc.ChannelArgsOrBuilder getChannelArgsOrBuilder()
       Custom channels args.
      .envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs channel_args = 8;