DS3 .NET Software Development Kit  3.0.0
Provides access to the Spectra Logic DS3 API through .NET.
Ds3.Ds3Builder Class Reference

Public Member Functions

 Ds3Builder (string endpoint, Credentials creds)
 
 Ds3Builder (Uri endpoint, Credentials creds)
 
Ds3Builder WithProxy (Uri proxy)
 Used to specify an HTTP proxy. More...
 
Ds3Builder WithRedirectRetries (int count)
 Sometimes the DS3 server isn't ready to service a request. In these situations it will periodically respond with a 307 redirect to keep the connection alive. The SDK makes this transparent if it happens up to RedirectRetries times. Use this to specify a limit on how many times this should happen before throwing an exception. More...
 
Ds3Builder WithCopyBufferSize (int copyBufferSize)
 Determines how many bytes to copy at a time to and from input streams when performing object GET and PUT operations. More...
 
Ds3Builder WithReadWriteTimeout (int readWriteTimeout)
 Specifies how long to wait for an HTTP request or response to transfer. More...
 
Ds3Builder WithRequestTimeout (int requestTimeout)
 Specifies how long to wait for the server to respond once the SDK has fully sent a request. More...
 
Ds3Builder WithConnectionLimit (int connectionLimit)
 Specifies how many concurrent connections we can open to a single host. More...
 
IDs3Client Build ()
 Creates the Ds3Client using the specified parameters. More...
 

Static Public Member Functions

static Ds3Builder FromEnv ()
 Creates a Ds3Builder with the endpoint, credentials, and proxy all populated from environment variables. More...
 

Constructor & Destructor Documentation

Ds3.Ds3Builder.Ds3Builder ( string  endpoint,
Credentials  creds 
)
inline

Parameters
endpointThe http or https location at which your DS3 server is listening.
credsCredentials with which to specify identity and sign requests.
Ds3.Ds3Builder.Ds3Builder ( Uri  endpoint,
Credentials  creds 
)
inline

Parameters
endpointThe http or https location at which your DS3 server is listening.
credsCredentials with which to specify identity and sign requests.

Member Function Documentation

IDs3Client Ds3.Ds3Builder.Build ( )
inline

Creates the Ds3Client using the specified parameters.

Returns
static Ds3Builder Ds3.Ds3Builder.FromEnv ( )
inlinestatic

Creates a Ds3Builder with the endpoint, credentials, and proxy all populated from environment variables.

Ds3Builder Ds3.Ds3Builder.WithConnectionLimit ( int  connectionLimit)
inline

Specifies how many concurrent connections we can open to a single host.

Parameters
connectionLimit
Returns
Ds3Builder Ds3.Ds3Builder.WithCopyBufferSize ( int  copyBufferSize)
inline

Determines how many bytes to copy at a time to and from input streams when performing object GET and PUT operations.

Parameters
copyBufferSize
Returns
Ds3Builder Ds3.Ds3Builder.WithProxy ( Uri  proxy)
inline

Used to specify an HTTP proxy.

Parameters
proxy
Returns
Ds3Builder Ds3.Ds3Builder.WithReadWriteTimeout ( int  readWriteTimeout)
inline

Specifies how long to wait for an HTTP request or response to transfer.

Parameters
readWriteTimeout
Returns
Ds3Builder Ds3.Ds3Builder.WithRedirectRetries ( int  count)
inline

Sometimes the DS3 server isn't ready to service a request. In these situations it will periodically respond with a 307 redirect to keep the connection alive. The SDK makes this transparent if it happens up to RedirectRetries times. Use this to specify a limit on how many times this should happen before throwing an exception.

Parameters
count
Returns
Ds3Builder Ds3.Ds3Builder.WithRequestTimeout ( int  requestTimeout)
inline

Specifies how long to wait for the server to respond once the SDK has fully sent a request.

Parameters
requestTimeout
Returns