Record Class ServiceConfig.MethodConfig

java.lang.Object

java.lang.Record

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

Record Components:

name - Names of the methods to which this configuration applies

waitForReady - Whether RPCs sent to this method should wait until the connection is ready by default

maxRequestMessage - maximum allowed payload size for an individual request or object in a stream

maxResponseMessage - maximum allowed payload size for an individual response or object in a stream

timeout - default timeout for RPCs sent to this method

retry - retry policy for outgoing RPCs

hedging - hedging policy for outgoing RPCs

Enclosing class:

ServiceConfig

public static record ServiceConfig.MethodConfig(List<ServiceConfig.MethodConfig.Name> name, Boolean waitForReady, DataSize maxRequestMessage, DataSize maxResponseMessage, Duration timeout, ServiceConfig.MethodConfig.RetryPolicy retry, ServiceConfig.MethodConfig.HedgingPolicy hedging)
extends Record

Method configuration.

Since:

4.1.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ServiceConfig.MethodConfig.HedgingPolicy	Hedging policy for outgoing RPCs.
static final record	ServiceConfig.MethodConfig.Name	The name of a gRPC method.
static final record	ServiceConfig.MethodConfig.RetryPolicy	Retry policy for outgoing RPCs.

Constructor Summary

Constructors

Constructor	Description
MethodConfig(List<ServiceConfig.MethodConfig.Name> name, Boolean waitForReady, DataSize maxRequestMessage, DataSize maxResponseMessage, Duration timeout, ServiceConfig.MethodConfig.RetryPolicy retry, ServiceConfig.MethodConfig.HedgingPolicy hedging)	Creates an instance of a MethodConfig record class.

Method Summary

Modifier and Type	Method	Description
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.
ServiceConfig.MethodConfig.HedgingPolicy	hedging()	Returns the value of the hedging record component.
DataSize	maxRequestMessage()	Returns the value of the maxRequestMessage record component.
DataSize	maxResponseMessage()	Returns the value of the maxResponseMessage record component.
List<ServiceConfig.MethodConfig.Name>	name()	Returns the value of the name record component.
ServiceConfig.MethodConfig.RetryPolicy	retry()	Returns the value of the retry record component.
Duration	timeout()	Returns the value of the timeout record component.
final String	toString()	Returns a string representation of this record class.
Boolean	waitForReady()	Returns the value of the waitForReady record component.

Methods inherited from class Object

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

Constructor Details

MethodConfig

public MethodConfig(List<ServiceConfig.MethodConfig.Name> name,
 Boolean waitForReady,
 DataSize maxRequestMessage,
 DataSize maxResponseMessage,
 Duration timeout,
 ServiceConfig.MethodConfig.RetryPolicy retry,
 ServiceConfig.MethodConfig.HedgingPolicy hedging)

Creates an instance of a MethodConfig record class.

Parameters:

name - the value for the name record component

waitForReady - the value for the waitForReady record component

maxRequestMessage - the value for the maxRequestMessage record component

maxResponseMessage - the value for the maxResponseMessage record component

timeout - the value for the timeout record component

retry - the value for the retry record component

hedging - the value for the hedging record component

Method Details

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.

name

public List<ServiceConfig.MethodConfig.Name> name()

Returns the value of the name record component.

Returns:

the value of the name record component

waitForReady

public Boolean waitForReady()

Returns the value of the waitForReady record component.

Returns:

the value of the waitForReady record component

maxRequestMessage

public DataSize maxRequestMessage()

Returns the value of the maxRequestMessage record component.

Returns:

the value of the maxRequestMessage record component

maxResponseMessage

public DataSize maxResponseMessage()

Returns the value of the maxResponseMessage record component.

Returns:

the value of the maxResponseMessage record component

timeout

public Duration timeout()

Returns the value of the timeout record component.

Returns:

the value of the timeout record component

retry

public ServiceConfig.MethodConfig.RetryPolicy retry()

Returns the value of the retry record component.

Returns:

the value of the retry record component

hedging

public ServiceConfig.MethodConfig.HedgingPolicy hedging()

Returns the value of the hedging record component.

Returns:

the value of the hedging record component