GrpcChannelProperties (grpc-client-spring-boot-autoconfigure 2.15.0.RELEASE API)

java.lang.Object
- net.devh.boot.grpc.client.config.GrpcChannelProperties

```
public class GrpcChannelProperties
extends Object
```
The channel properties for a single named gRPC channel or service reference.

Since:

5/17/16

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GrpcChannelProperties.Security
A container with options for the channel's transport security.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GrpcChannelProperties.Security` A container with options for the channel's transport security.

Constructor Summary

Constructors
Constructor and Description

GrpcChannelProperties()

Constructors
Constructor and Description
`GrpcChannelProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`void`	`copyDefaultsFrom(GrpcChannelProperties config)` Copies the defaults from the given configuration.
`boolean`	`equals(Object o)`
`URI`	`getAddress()` Gets the target address uri.
`String`	`getDefaultLoadBalancingPolicy()` Gets the default load balancing policy this channel should use.
`Duration`	`getImmediateConnectTimeout()` Get the connection timeout at application startup.
`Duration`	`getKeepAliveTime()` Gets the default delay before we send a keepAlive.
`Duration`	`getKeepAliveTimeout()` The default timeout for a keepAlives ping request.
`DataSize`	`getMaxInboundMessageSize()` Gets the maximum message size allowed to be received by the channel.
`NegotiationType`	`getNegotiationType()` Gets the negotiation type to use on the connection.
`GrpcChannelProperties.Security`	`getSecurity()` Gets the options for transport security.
`Duration`	`getShutdownGracePeriod()` Gets the time to wait for the channel to gracefully shutdown.
`int`	`hashCode()`
`boolean`	`isEnableKeepAlive()` Gets whether keepAlive is enabled.
`boolean`	`isFullStreamDecompression()` Gets whether full-stream decompression of inbound streams should be enabled.
`boolean`	`isKeepAliveWithoutCalls()` Gets whether keepAlive will be performed when there are no outstanding RPC on a connection.
`void`	`setAddress(String address)` Sets the target address uri for the channel.
`void`	`setAddress(URI address)` Set the address uri for the channel.
`void`	`setDefaultLoadBalancingPolicy(String defaultLoadBalancingPolicy)` Sets the default load balancing policy for this channel.
`void`	`setEnableKeepAlive(Boolean enableKeepAlive)` Sets whether keepAlive should be enabled.
`void`	`setFullStreamDecompression(Boolean fullStreamDecompression)` Sets whether full-stream decompression of inbound streams should be enabled.
`void`	`setImmediateConnectTimeout(Duration immediateConnectTimeout)` If set to a positive duration instructs the client to connect to the gRPC endpoint when the GRPC stub is created.
`void`	`setKeepAliveTime(Duration keepAliveTime)` The default delay before we send a keepAlives.
`void`	`setKeepAliveTimeout(Duration keepAliveTimeout)` The default timeout for a keepAlives ping request.
`void`	`setKeepAliveWithoutCalls(Boolean keepAliveWithoutCalls)` Sets whether keepAlive will be performed when there are no outstanding RPC on a connection.
`void`	`setMaxInboundMessageSize(DataSize maxInboundMessageSize)` Sets the maximum message size in bytes allowed to be received by the channel.
`void`	`setNegotiationType(NegotiationType negotiationType)` Sets the negotiation type to use on the connection.
`void`	`setShutdownGracePeriod(Duration shutdownGracePeriod)` Sets the time to wait for the channel to gracefully shutdown (completing all requests).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GrpcChannelProperties
```
public GrpcChannelProperties()
```
- Method Detail
  - getAddress
```
public URI getAddress()
```
    Gets the target address uri.
    
    Returns:
    
    The address to connect to or null
    
    See Also:
    
    setAddress(String)
  - setAddress
```
public void setAddress(URI address)
```
    Set the address uri for the channel. If nothing is configured then the name of the client will be used along with the default scheme. We recommend explicitly configuring the scheme used for the address resolutions such as dns:/.
    
    Parameters:
    
    address - The address to use for the channel or null to default to the fallback.
    
    See Also:
    
    setAddress(String)
  - setAddress
```
public void setAddress(String address)
```
    Sets the target address uri for the channel. The target uri must be in the format: schema:[//[authority]][/path]. If nothing is configured then the name of the client will be used along with the default scheme. We recommend explicitly configuring the scheme used for the address resolutions such as dns:/.
    Examples
    - static://localhost:9090 (refers to exactly one IPv4 or IPv6 address, dependent on the jre configuration, it does not check whether there is actually someone listening on that network interface)
    - static://10.0.0.10
    - static://10.0.0.10,10.11.12.11
    - static://10.0.0.10:9090,10.0.0.11:80,10.0.0.12:1234,[::1]:8080
    - dns:/localhost (might refer to the IPv4 or the IPv6 address or both, dependent on the system configuration, it does not check whether there is actually someone listening on that network interface)
    - dns:/example.com
    - dns:/example.com:9090
    - dns:///example.com:9090
    - discovery:/foo-service
    - discovery:///foo-service
    - unix:<relative-path> (Additional dependencies may be required)
    - unix://</absolute-path> (Additional dependencies may be required)
    Parameters:
    
    address - The string representation of an uri to use as target address or null to use a fallback.
    
    See Also:
    
    gRPC Name Resolution, NameResolverProvider
  - getDefaultLoadBalancingPolicy
```
public String getDefaultLoadBalancingPolicy()
```
    Gets the default load balancing policy this channel should use.
    
    Returns:
    
    The default load balancing policy.
    
    See Also:
    
    ManagedChannelBuilder.defaultLoadBalancingPolicy(String)
  - setDefaultLoadBalancingPolicy
```
public void setDefaultLoadBalancingPolicy(String defaultLoadBalancingPolicy)
```
    Sets the default load balancing policy for this channel. This config might be overwritten by the service config received from the target address. The names have to be resolvable from the LoadBalancerRegistry. By default this the round_robin policy. Please note that this policy is different from the normal grpc-java default policy pick_first.
    
    Parameters:
    
    defaultLoadBalancingPolicy - The default load balancing policy to use or null to use the fallback.
  - isEnableKeepAlive
```
public boolean isEnableKeepAlive()
```
    Gets whether keepAlive is enabled.
    
    Returns:
    
    True, if keep alive should be enabled. False otherwise.
    
    See Also:
    
    setEnableKeepAlive(Boolean)
  - setEnableKeepAlive
```
public void setEnableKeepAlive(Boolean enableKeepAlive)
```
    Sets whether keepAlive should be enabled. Defaults to false.
    
    Parameters:
    
    enableKeepAlive - True, to enable. False, to disable. Null, to use the fallback.
  - getKeepAliveTime
```
public Duration getKeepAliveTime()
```
    Gets the default delay before we send a keepAlive.
    
    Returns:
    
    The default delay before sending keepAlives.
    
    See Also:
    
    setKeepAliveTime(Duration)
  - setKeepAliveTime
```
public void setKeepAliveTime(Duration keepAliveTime)
```
    The default delay before we send a keepAlives. Defaults to 5min. Default unit SECONDS. Please note that shorter intervals increase the network burden for the server. Cannot be lower than permitKeepAliveTime on server (default 5min).
    
    Parameters:
    
    keepAliveTime - The new default delay before sending keepAlives, or null to use the fallback.
    
    See Also:
    
    setEnableKeepAlive(Boolean), NettyChannelBuilder.keepAliveTime(long, TimeUnit)
  - getKeepAliveTimeout
```
public Duration getKeepAliveTimeout()
```
    The default timeout for a keepAlives ping request.
    
    Returns:
    
    The default timeout for a keepAlives ping request.
    
    See Also:
    
    setKeepAliveTimeout(Duration)
  - setKeepAliveTimeout
```
public void setKeepAliveTimeout(Duration keepAliveTimeout)
```
    The default timeout for a keepAlives ping request. Defaults to 20s. Default unit SECONDS.
    
    Parameters:
    
    keepAliveTimeout - The default timeout for a keepAlives ping request.
    
    See Also:
    
    setEnableKeepAlive(Boolean), NettyChannelBuilder.keepAliveTimeout(long, TimeUnit)
  - isKeepAliveWithoutCalls
```
public boolean isKeepAliveWithoutCalls()
```
    Gets whether keepAlive will be performed when there are no outstanding RPC on a connection.
    
    Returns:
    
    True, if keepAlives should be performed even when there are no RPCs. False otherwise.
    
    See Also:
    
    setKeepAliveWithoutCalls(Boolean)
  - setKeepAliveWithoutCalls
```
public void setKeepAliveWithoutCalls(Boolean keepAliveWithoutCalls)
```
    Sets whether keepAlive will be performed when there are no outstanding RPC on a connection. Defaults to false.
    
    Parameters:
    
    keepAliveWithoutCalls - whether keepAlive will be performed when there are no outstanding RPC on a connection.
    
    See Also:
    
    setEnableKeepAlive(Boolean), NettyChannelBuilder.keepAliveWithoutCalls(boolean)
  - getShutdownGracePeriod
```
public Duration getShutdownGracePeriod()
```
    Gets the time to wait for the channel to gracefully shutdown. If set to a negative value, the channel waits forever. If set to 0 the channel will force shutdown immediately. Defaults to 30s.
    
    Returns:
    
    The time to wait for a graceful shutdown.
  - setShutdownGracePeriod
```
public void setShutdownGracePeriod(Duration shutdownGracePeriod)
```
    Sets the time to wait for the channel to gracefully shutdown (completing all requests). If set to a negative value, the channel waits forever. If set to 0 the channel will force shutdown immediately. Defaults to 30s.
    
    Parameters:
    
    shutdownGracePeriod - The time to wait for a graceful shutdown.
  - getMaxInboundMessageSize
```
public DataSize getMaxInboundMessageSize()
```
    Gets the maximum message size allowed to be received by the channel. If not set (null) then gRPC's default should be used. If set to -1 then it will use the highest possible limit (not recommended).
    
    Returns:
    
    The maximum message size allowed or null if the default should be used.
    
    See Also:
    
    setMaxInboundMessageSize(DataSize)
  - setMaxInboundMessageSize
```
public void setMaxInboundMessageSize(DataSize maxInboundMessageSize)
```
    Sets the maximum message size in bytes allowed to be received by the channel. If not set (null) then it will default to gRPC's default. If set to -1 then it will use the highest possible limit (not recommended).
    
    Parameters:
    
    maxInboundMessageSize - The new maximum size in bytes allowed for incoming messages. -1 for max possible. Null to use the gRPC's default.
    
    See Also:
    
    ManagedChannelBuilder.maxInboundMessageSize(int)
  - isFullStreamDecompression
```
public boolean isFullStreamDecompression()
```
    Gets whether full-stream decompression of inbound streams should be enabled.
    
    Returns:
    
    True, if full-stream decompression of inbound streams should be enabled. False otherwise.
    
    See Also:
    
    setFullStreamDecompression(Boolean)
  - setFullStreamDecompression
```
public void setFullStreamDecompression(Boolean fullStreamDecompression)
```
    Sets whether full-stream decompression of inbound streams should be enabled. This will cause the channel's outbound headers to advertise support for GZIP compressed streams, and gRPC servers which support the feature may respond with a GZIP compressed stream.
    
    Parameters:
    
    fullStreamDecompression - Whether full stream decompression should be enabled or null to use the fallback.
    
    See Also:
    
    ManagedChannelBuilder.enableFullStreamDecompression()
  - getNegotiationType
```
public NegotiationType getNegotiationType()
```
    Gets the negotiation type to use on the connection.
    
    Returns:
    
    The negotiation type that the channel will use.
    
    See Also:
    
    setNegotiationType(NegotiationType)
  - setNegotiationType
```
public void setNegotiationType(NegotiationType negotiationType)
```
    Sets the negotiation type to use on the connection. Either of TLS (recommended), PLAINTEXT_UPGRADE or PLAINTEXT. Defaults to TLS.
    
    Parameters:
    
    negotiationType - The negotiation type to use or null to use the fallback.
  - getImmediateConnectTimeout
```
public Duration getImmediateConnectTimeout()
```
    Get the connection timeout at application startup.
    
    Returns:
    
    connection timeout at application startup.
    
    See Also:
    
    setImmediateConnectTimeout(Duration)
  - setImmediateConnectTimeout
```
public void setImmediateConnectTimeout(Duration immediateConnectTimeout)
```
    If set to a positive duration instructs the client to connect to the gRPC endpoint when the GRPC stub is created. As a result the application startup will be slightly slower due to connection process being executed synchronously up to the maximum to connection timeout. If the connection fails, the stub will fail to create with an exception which in turn causes the application context startup to fail. Defaults to 0.
    
    Parameters:
    
    immediateConnectTimeout - Connection timeout at application startup.
  - getSecurity
```
public GrpcChannelProperties.Security getSecurity()
```
    Gets the options for transport security.
    
    Returns:
    
    The options for transport security.
  - copyDefaultsFrom
```
public void copyDefaultsFrom(GrpcChannelProperties config)
```
    Copies the defaults from the given configuration. Values are considered "default" if they are null. Please note that the getters might return fallback values instead.
    
    Parameters:
    
    config - The config to copy the defaults from.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class GrpcChannelProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrpcChannelProperties

Method Detail

getAddress

setAddress

setAddress

getDefaultLoadBalancingPolicy

setDefaultLoadBalancingPolicy

isEnableKeepAlive

setEnableKeepAlive

getKeepAliveTime

setKeepAliveTime

getKeepAliveTimeout

setKeepAliveTimeout

isKeepAliveWithoutCalls

setKeepAliveWithoutCalls

getShutdownGracePeriod

setShutdownGracePeriod

getMaxInboundMessageSize

setMaxInboundMessageSize

isFullStreamDecompression

setFullStreamDecompression

getNegotiationType

setNegotiationType

getImmediateConnectTimeout

setImmediateConnectTimeout

getSecurity

copyDefaultsFrom

toString

equals

canEqual

hashCode