Interface GrpcClientConfig

All Superinterfaces:
HttpClientConfig, HttpConfigBase, Prototype.Api, Prototype.Factory<GrpcClient>
All Known Implementing Classes:
GrpcClientConfig.BuilderBase.GrpcClientConfigImpl

public interface GrpcClientConfig extends Prototype.Api, HttpClientConfig
Configuration of a grpc client.
See Also:
  • Method Details

    • builder

      static GrpcClientConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder
    • builder

      static GrpcClientConfig.Builder builder(GrpcClientConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance
    • create

      static GrpcClientConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      @Deprecated static GrpcClientConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      static GrpcClientConfig create()
      Create a new instance with default values.
      Returns:
      a new instance
    • protocolConfig

      GrpcClientProtocolConfig protocolConfig()
      gRPC specific configuration.
      Returns:
      protocol specific configuration
    • clientUriSupplier

      Optional<ClientUriSupplier> clientUriSupplier()
      A ClientUriSupplier that can dynamically provide zero or more ClientUris to connect.
      Returns:
      a supplier for zero or more client URIs
    • enableMetrics

      boolean enableMetrics()
      Whether to collect metrics for gRPC client calls.
      Returns:
      metrics flag
    • grpcServices

      List<GrpcClientService> grpcServices()
      gRPC client services. A gRPC service needs to be explicitly added to be enabled given that discoveredServices is false.
      Returns:
      services to use with this gRPC client
    • defaultRequestHeaders

      default ClientRequestHeaders defaultRequestHeaders()
      Default headers as a headers object. Creates a new instance for each call, so the returned value can be safely mutated.
      Returns:
      default headers