com.microsoft.azure.cosmosdb.internal.directconnectivity

Class RntbdTransportClient.Options.Builder

java.lang.Object

com.microsoft.azure.cosmosdb.internal.directconnectivity.RntbdTransportClient.Options.Builder

Enclosing class:

RntbdTransportClient.Options

public static class RntbdTransportClient.Options.Builder
extends Object

A builder for constructing RntbdTransportClient.Options instances.

Using system properties to set the default RntbdTransportClient.Options used by an RntbdTransportClient.Options.Builder

A default options instance is created when the RntbdTransportClient.Options.Builder class is initialized. This instance specifies the default options used by every RntbdTransportClient.Options.Builder instance. In priority order the default options instance is created from:

1. The JSON value of system property azure.cosmos.directTcp.defaultOptions.

   Example:

    -Dazure.cosmos.directTcp.defaultOptions={\"maxChannelsPerEndpoint\":5,\"maxRequestsPerChannel\":30}

2. The contents of the JSON file located by system property azure.cosmos.directTcp .defaultOptionsFile.

   Example:

    -Dazure.cosmos.directTcp.defaultOptionsFile=/path/to/default/options/file

3. The contents of JSON resource file azure.cosmos.directTcp.defaultOptions.json.

   Specifically, the resource file is read from this stream:

    RntbdTransportClient.class.getClassLoader().getResourceAsStream("azure.cosmos.directTcp.defaultOptions.json")

   Example:

    {
      "bufferPageSize": 8192,
      "connectionTimeout": "PT1M",
      "idleChannelTimeout": "PT0S",
      "idleEndpointTimeout": "PT1M10S",
      "maxBufferCapacity": 8388608,
      "maxChannelsPerEndpoint": 10,
      "maxRequestsPerChannel": 30,
      "receiveHangDetectionTime": "PT1M5S",
      "requestExpiryInterval": "PT5S",
      "requestTimeout": "PT1M",
      "requestTimerResolution": "PT0.5S",
      "sendHangDetectionTime": "PT10S",
      "shutdownTimeout": "PT15S"
    }

JSON value errors are logged and then ignored. If none of the above values are available or all available values are in error, the default options instance is created from the private parameterless constructor for RntbdTransportClient.Options.

Constructor Summary

Constructors

Constructor and Description
Builder(Duration requestTimeout)
Builder(int requestTimeoutInSeconds)

Method Summary

Modifier and Type	Method and Description
RntbdTransportClient.Options.Builder	bufferPageSize(int value)
RntbdTransportClient.Options	build()
RntbdTransportClient.Options.Builder	connectionTimeout(Duration value)
RntbdTransportClient.Options.Builder	idleChannelTimeout(Duration value)
RntbdTransportClient.Options.Builder	idleEndpointTimeout(Duration value)
RntbdTransportClient.Options.Builder	maxBufferCapacity(int value)
RntbdTransportClient.Options.Builder	maxChannelsPerEndpoint(int value)
RntbdTransportClient.Options.Builder	maxRequestsPerChannel(int value)
RntbdTransportClient.Options.Builder	receiveHangDetectionTime(Duration value)
RntbdTransportClient.Options.Builder	requestExpiryInterval(Duration value)
RntbdTransportClient.Options.Builder	requestTimeout(Duration value)
RntbdTransportClient.Options.Builder	requestTimerResolution(Duration value)
RntbdTransportClient.Options.Builder	sendHangDetectionTime(Duration value)
RntbdTransportClient.Options.Builder	shutdownTimeout(Duration value)
RntbdTransportClient.Options.Builder	userAgent(com.microsoft.azure.cosmosdb.internal.UserAgentContainer value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(Duration requestTimeout)

Builder

public Builder(int requestTimeoutInSeconds)

Method Detail

bufferPageSize

public RntbdTransportClient.Options.Builder bufferPageSize(int value)

build

public RntbdTransportClient.Options build()

connectionTimeout

public RntbdTransportClient.Options.Builder connectionTimeout(Duration value)

idleChannelTimeout

public RntbdTransportClient.Options.Builder idleChannelTimeout(Duration value)

idleEndpointTimeout

public RntbdTransportClient.Options.Builder idleEndpointTimeout(Duration value)

maxBufferCapacity

public RntbdTransportClient.Options.Builder maxBufferCapacity(int value)

maxChannelsPerEndpoint

public RntbdTransportClient.Options.Builder maxChannelsPerEndpoint(int value)

maxRequestsPerChannel

public RntbdTransportClient.Options.Builder maxRequestsPerChannel(int value)

receiveHangDetectionTime

public RntbdTransportClient.Options.Builder receiveHangDetectionTime(Duration value)

requestExpiryInterval

public RntbdTransportClient.Options.Builder requestExpiryInterval(Duration value)

requestTimeout

public RntbdTransportClient.Options.Builder requestTimeout(Duration value)

requestTimerResolution

public RntbdTransportClient.Options.Builder requestTimerResolution(Duration value)

sendHangDetectionTime

public RntbdTransportClient.Options.Builder sendHangDetectionTime(Duration value)

shutdownTimeout

public RntbdTransportClient.Options.Builder shutdownTimeout(Duration value)

userAgent

public RntbdTransportClient.Options.Builder userAgent(com.microsoft.azure.cosmosdb.internal.UserAgentContainer value)