com.aliyun.oss

Interface OSSBuilder

All Known Implementing Classes:

OSSClientBuilder

public interface OSSBuilder

Fluent builder for OSS Client. Use of the builder is preferred over using constructors of the client class.

Method Summary

Modifier and Type	Method and Description
OSS	build(String endpoint, CredentialsProvider credsProvider) Uses the specified CredentialsProvider and OSS Endpoint to create a new OSSClient instance.
OSS	build(String endpoint, CredentialsProvider credsProvider, ClientBuilderConfiguration config) Uses the specified CredentialsProvider, client configuration and OSS endpoint to create a new OSSClient instance.
OSS	build(String endpoint, String accessKeyId, String secretAccessKey) Uses the specified OSS Endpoint and Access Id/Access Key to create a new OSSClient instance.
OSS	build(String endpoint, String accessKeyId, String secretAccessKey, ClientBuilderConfiguration config) Uses a specified OSS Endpoint, Access Id, Access Key, Client side configuration to create a OSSClient instance.
OSS	build(String endpoint, String accessKeyId, String secretAccessKey, String securityToken) Uses the specified OSS Endpoint, a security token from AliCloud STS and Access Id/Access Key to create a new OSSClient instance.
OSS	build(String endpoint, String accessKeyId, String secretAccessKey, String securityToken, ClientBuilderConfiguration config) Uses specified OSS Endpoint, the temporary (Access Id/Access Key/Security Token) from STS and the client configuration to create a new OSSClient instance.

Method Detail

build

OSS build(String endpoint,
          String accessKeyId,
          String secretAccessKey)

Uses the specified OSS Endpoint and Access Id/Access Key to create a new OSSClient instance.

Parameters:

endpoint - OSS endpoint.

accessKeyId - Access Key ID.

secretAccessKey - Secret Access Key.

Returns:

An instance that implements the OSS.

build

OSS build(String endpoint,
          String accessKeyId,
          String secretAccessKey,
          String securityToken)

Uses the specified OSS Endpoint, a security token from AliCloud STS and Access Id/Access Key to create a new OSSClient instance.

Parameters:

endpoint - OSS Endpoint.

accessKeyId - Access Id from STS.

secretAccessKey - Access Key from STS

securityToken - Security Token from STS.

Returns:

An instance that implements the OSS.

build

OSS build(String endpoint,
          String accessKeyId,
          String secretAccessKey,
          ClientBuilderConfiguration config)

Uses a specified OSS Endpoint, Access Id, Access Key, Client side configuration to create a OSSClient instance.

Parameters:

endpoint - OSS Endpoint.

accessKeyId - Access Key ID.

secretAccessKey - Secret Access Key.

config - A ClientBuilderConfiguration instance. The method would use default configuration if it's null.

Returns:

An instance that implements the OSS.

build

OSS build(String endpoint,
          String accessKeyId,
          String secretAccessKey,
          String securityToken,
          ClientBuilderConfiguration config)

Uses specified OSS Endpoint, the temporary (Access Id/Access Key/Security Token) from STS and the client configuration to create a new OSSClient instance.

Parameters:

endpoint - OSS Endpoint.

accessKeyId - Access Key Id provided by STS.

secretAccessKey - Secret Access Key provided by STS.

securityToken - Security token provided by STS.

config - A ClientBuilderConfiguration instance. The method would use default configuration if it's null.

Returns:

An instance that implements the OSS.

build

OSS build(String endpoint,
          CredentialsProvider credsProvider)

Uses the specified CredentialsProvider and OSS Endpoint to create a new OSSClient instance.

Parameters:

endpoint - OSS services Endpoint.

credsProvider - Credentials provider which has access key Id and access Key secret.

Returns:

An instance that implements the OSS.

build

OSS build(String endpoint,
          CredentialsProvider credsProvider,
          ClientBuilderConfiguration config)

Uses the specified CredentialsProvider, client configuration and OSS endpoint to create a new OSSClient instance.

Parameters:

endpoint - OSS services Endpoint.

credsProvider - Credentials provider.

config - client configuration.

Returns:

An instance that implements the OSS.