Package com.osohq.oso_cloud

Class OsoClientOptions.Builder

java.lang.Object

com.osohq.oso_cloud.OsoClientOptions.Builder

Enclosing class:

OsoClientOptions

public static class OsoClientOptions.Builder
extends java.lang.Object

Builder for constructing OsoClientOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OsoClientOptions	build()	Return the built OsoClientOptions.
OsoClientOptions.Builder	withDataBindingsPath(java.nio.file.Path dataBindingsPath)	Set the local authorization data bindings path for the client.
OsoClientOptions.Builder	withDefaultTimeoutMilliseconds(java.lang.Integer defaultTimeoutMilliseconds)	Set the maximum time to spend waiting for a response from Oso Cloud.
OsoClientOptions.Builder	withFallbackUri(java.net.URI fallbackUri)	Set the fallback URI for the client.
OsoClientOptions.Builder	withReadTimeoutMilliseconds(java.lang.Integer readTimeoutMilliseconds)	Set the maximum time to spend waiting for a response from Oso Cloud for read requests like Oso.authorize(com.osohq.oso_cloud.Value, java.lang.String, com.osohq.oso_cloud.Value, java.util.List<com.osohq.oso_cloud.Fact>, com.osohq.oso_cloud.ParityHandle) and Oso.actions(com.osohq.oso_cloud.Value, com.osohq.oso_cloud.Value, java.util.List<com.osohq.oso_cloud.Fact>).
OsoClientOptions.Builder	withTimeoutMilliseconds(java.lang.Integer timeoutMilliseconds)	Deprecated. use withDefaultTimeoutMilliseconds(Integer) instead.
OsoClientOptions.Builder	withWriteTimeoutMilliseconds(java.lang.Integer writeTimeoutMilliseconds)	Set the maximum time to spend waiting for a response from Oso Cloud for write requests like Oso.insert(com.osohq.oso_cloud.Fact) and Oso.batch(java.util.function.Consumer<com.osohq.oso_cloud.BatchTransaction>).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withFallbackUri

public OsoClientOptions.Builder withFallbackUri(java.net.URI fallbackUri)

Set the fallback URI for the client.

Parameters:

fallbackUri - The uri for your Oso Fallback Node

Returns:

Builder

withDataBindingsPath

public OsoClientOptions.Builder withDataBindingsPath(java.nio.file.Path dataBindingsPath)

Set the local authorization data bindings path for the client.

Parameters:

dataBindingsPath - the path to your local authorization YAML file

Returns:

Builder

withTimeoutMilliseconds

@Deprecated
public OsoClientOptions.Builder withTimeoutMilliseconds(java.lang.Integer timeoutMilliseconds)

Deprecated.

use withDefaultTimeoutMilliseconds(Integer) instead.

withDefaultTimeoutMilliseconds

public OsoClientOptions.Builder withDefaultTimeoutMilliseconds(java.lang.Integer defaultTimeoutMilliseconds)

Set the maximum time to spend waiting for a response from Oso Cloud. Timed out SDK methods will throw a IOException. Will not be applied to a request if a more specific timeout was set for that type of request via withReadTimeoutMilliseconds(Integer) or withWriteTimeoutMilliseconds(Integer).

Parameters:

defaultTimeoutMilliseconds - timeout, in milliseconds

Returns:

Builder

See Also:

withReadTimeoutMilliseconds(Integer), withWriteTimeoutMilliseconds(Integer)

withReadTimeoutMilliseconds

public OsoClientOptions.Builder withReadTimeoutMilliseconds(java.lang.Integer readTimeoutMilliseconds)

Set the maximum time to spend waiting for a response from Oso Cloud for read requests like Oso.authorize(com.osohq.oso_cloud.Value, java.lang.String, com.osohq.oso_cloud.Value, java.util.List<com.osohq.oso_cloud.Fact>, com.osohq.oso_cloud.ParityHandle) and Oso.actions(com.osohq.oso_cloud.Value, com.osohq.oso_cloud.Value, java.util.List<com.osohq.oso_cloud.Fact>). If set, any default timeout set via withDefaultTimeoutMilliseconds(Integer) will be ignored for read requests.

Parameters:

readTimeoutMilliseconds - timeout, in milliseconds

Returns:

Builder

withWriteTimeoutMilliseconds

public OsoClientOptions.Builder withWriteTimeoutMilliseconds(java.lang.Integer writeTimeoutMilliseconds)

Set the maximum time to spend waiting for a response from Oso Cloud for write requests like Oso.insert(com.osohq.oso_cloud.Fact) and Oso.batch(java.util.function.Consumer<com.osohq.oso_cloud.BatchTransaction>). If set, any default timeout set via withDefaultTimeoutMilliseconds(Integer) will be ignored for write requests.

Parameters:

writeTimeoutMilliseconds - timeout, in milliseconds

Returns:

Builder

build

public OsoClientOptions build()

Return the built OsoClientOptions.

Returns:

OsoClientOptions