Record Class ServiceConfig

java.lang.Object

java.lang.Record

org.springframework.boot.grpc.client.autoconfigure.ServiceConfig

Record Components:

loadbalancing - load balancing configurations in the order that they should be applied

method - method configuration

retrythrottling - retry throttling policy

healthcheck - health check configuration

public record ServiceConfig(@Nullable List<ServiceConfig.LoadBalancingConfig> loadbalancing, @Nullable List<ServiceConfig.MethodConfig> method, @Nullable ServiceConfig.RetryThrottlingPolicy retrythrottling, @Nullable ServiceConfig.HealthCheckConfig healthcheck)
extends Record

Bindable service configuration for gRPC channel. Allows type safe binding of common service configuration options which can ultimately be applied to the Map provided by a GrpcClientDefaultServiceConfigCustomizer.

The configuration provided here is a subset of the canonical service_config.proto protocol definition. For advanced or experimental service configurations, use the GrpcClientDefaultServiceConfigCustomizer to directly add any entries supported by grpc-java.

Since:

4.1.0

Author:

Phillip Webb

See Also:

• GrpcClientDefaultServiceConfigCustomizer
• ServiceConfigUtil

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ServiceConfig.HealthCheckConfig	Health check configuration.
static final record	ServiceConfig.LoadBalancingConfig	Load balancing config.
static final record	ServiceConfig.MethodConfig	Method configuration.
static final record	ServiceConfig.RetryThrottlingPolicy	Retry throttling policy.

Constructor Summary

Constructors

Constructor	Description
ServiceConfig(@Nullable List<ServiceConfig.LoadBalancingConfig> loadbalancing, @Nullable List<ServiceConfig.MethodConfig> method, @Nullable ServiceConfig.RetryThrottlingPolicy retrythrottling, @Nullable ServiceConfig.HealthCheckConfig healthcheck)	Creates an instance of a ServiceConfig record class.

Method Summary

Modifier and Type	Method	Description
void	applyTo(Map<String,Object> grpcJavaConfig)	Apply this service config to the given gRPC Java config Map.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable ServiceConfig.HealthCheckConfig	healthcheck()	Returns the value of the healthcheck record component.
@Nullable List<ServiceConfig.LoadBalancingConfig>	loadbalancing()	Returns the value of the loadbalancing record component.
@Nullable List<ServiceConfig.MethodConfig>	method()	Returns the value of the method record component.
@Nullable ServiceConfig.RetryThrottlingPolicy	retrythrottling()	Returns the value of the retrythrottling record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ServiceConfig

public ServiceConfig(@Nullable List<ServiceConfig.LoadBalancingConfig> loadbalancing,
 @Nullable List<ServiceConfig.MethodConfig> method,
 @Nullable ServiceConfig.RetryThrottlingPolicy retrythrottling,
 @Nullable ServiceConfig.HealthCheckConfig healthcheck)

Creates an instance of a ServiceConfig record class.

Parameters:

loadbalancing - the value for the loadbalancing record component

method - the value for the method record component

retrythrottling - the value for the retrythrottling record component

healthcheck - the value for the healthcheck record component

Method Details

applyTo

public void applyTo(Map<String,Object> grpcJavaConfig)

Apply this service config to the given gRPC Java config Map.

Parameters:

grpcJavaConfig - the gRPC Java config map

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

loadbalancing

public @Nullable List<ServiceConfig.LoadBalancingConfig> loadbalancing()

Returns the value of the loadbalancing record component.

Returns:

the value of the loadbalancing record component

method

public @Nullable List<ServiceConfig.MethodConfig> method()

Returns the value of the method record component.

Returns:

the value of the method record component

retrythrottling

public @Nullable ServiceConfig.RetryThrottlingPolicy retrythrottling()

Returns the value of the retrythrottling record component.

Returns:

the value of the retrythrottling record component

healthcheck

public @Nullable ServiceConfig.HealthCheckConfig healthcheck()

Returns the value of the healthcheck record component.

Returns:

the value of the healthcheck record component