Class ClientConfig.Builder

Builds a ClientConfig instance

Inheritance
System.Object
ClientConfig.Builder
Namespace: Adobe.PDFServicesSDK.config
Assembly: Adobe.PDFServicesSDK.Doc.dll
Syntax
public class Builder

Constructors

Builder()

Constructs a Builder instance.

Declaration
public Builder()

Methods

Build()

Returns a new ClientConfig instance built from the current state of this builder.

Declaration
public ClientConfig Build()
Returns
Type Description
ClientConfig

a new ClientConfig instance

FromFile(String)

Sets the timeout and region code using the JSON client config file path. All the keys in the JSON structure are optional.

JSON structure: 

    {
    "timeout": "400000",
    "region": "EU",
    }

Declaration
public ClientConfig.Builder FromFile(string clientConfigFilePath)
Parameters
Type Name Description
System.String clientConfigFilePath

JSON client config file path
Returns
Type Description
ClientConfig.Builder

this Builder instance to add any additional parameters

SetRegion(Region)

Sets the region code.

Declaration
public ClientConfig.Builder SetRegion(Region region)
Parameters
Type Name Description
Region region

a Region instance. Default value is US.
Returns
Type Description
ClientConfig.Builder

this Builder instance to add any additional parameters

WithProxyServerConfig(ProxyServerConfig)

Sets the configuration for the proxy server.

Declaration
public ClientConfig.Builder WithProxyServerConfig(ProxyServerConfig proxyServerConfig)
Parameters
Type Name Description
ProxyServerConfig proxyServerConfig

A ProxyServerConfig instance for providing proxy server configuration.
Returns
Type Description
ClientConfig.Builder

This ClientConfig.Builder instance to add any additional parameters.

WithTimeout(Int32)

Sets the timeout. It should be greater than zero.

Declaration
public ClientConfig.Builder WithTimeout(int timeout)
Parameters
Type Name Description
System.Int32 timeout

specifies the timeout in milliseconds for establishing a connection, sending a request, and getting a response. Default value is 400000 milliseconds
Returns
Type Description
ClientConfig.Builder

this Builder instance to add any additional parameters