com.aliyun.odps.storage

Class MaxStorageClient.Builder

java.lang.Object

com.aliyun.odps.storage.MaxStorageClient.Builder

Enclosing class:

MaxStorageClient

public static class MaxStorageClient.Builder
extends Object

Builder class for constructing MaxStorageClient instances.

This builder allows configuration of various client settings including:

• Endpoint and tunnel endpoint URLs
• Project and region information
• Credentials provider for authentication
• Retry settings for handling transient failures
• HTTP settings for connection management
• Buffer allocator for memory management

Example usage:

 MaxStorageClient client = MaxStorageClient.builder()
     .endpoint("https://service.cn-hangzhou.maxcompute.aliyun.com/api")
     .credentialsProvider(credentialsProvider)
     .httpSettings(HttpSettings.newBuilder().build())
     .build();
 

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MaxStorageClient.Builder	bufferAllocator(org.apache.arrow.memory.BufferAllocator bufferAllocator) Sets the buffer allocator for memory management.
MaxStorageClient	build() Builds and returns a new MaxStorageClient instance with the configured settings.
MaxStorageClient.Builder	credentialsProvider(com.aliyun.credentials.api.ICredentialsProvider credentialsProvider) Sets the credentials provider for authentication.
MaxStorageClient.Builder	endpoint(String endpoint) Sets the MaxCompute service endpoint.
MaxStorageClient.Builder	httpSettings(HttpSettings httpSettings) Sets the HTTP settings for connection management.
MaxStorageClient.Builder	project(String project) Sets the MaxCompute project name.
MaxStorageClient.Builder	quota(String quota) Sets the MaxCompute quota.
MaxStorageClient.Builder	region(String region) Sets the MaxCompute region.
MaxStorageClient.Builder	tunnelEndpoint(String tunnelEndpoint) Sets the MaxCompute tunnel endpoint.
MaxStorageClient.Builder	userAgent(String userAgent) Appends a custom string to the 'User-Agent' header for all MaxStorage requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

endpoint

public MaxStorageClient.Builder endpoint(String endpoint)

Sets the MaxCompute service endpoint.

Parameters:

endpoint - The MaxCompute service endpoint URL

Returns:

This builder instance for method chaining

project

public MaxStorageClient.Builder project(String project)

Sets the MaxCompute project name.

Parameters:

project - The project name

Returns:

This builder instance for method chaining

tunnelEndpoint

public MaxStorageClient.Builder tunnelEndpoint(String tunnelEndpoint)

Sets the MaxCompute tunnel endpoint.

Parameters:

tunnelEndpoint - The tunnel endpoint URL

Returns:

This builder instance for method chaining

region

public MaxStorageClient.Builder region(String region)

Sets the MaxCompute region.

Parameters:

region - The region name

Returns:

This builder instance for method chaining

quota

public MaxStorageClient.Builder quota(String quota)

Sets the MaxCompute quota.

Parameters:

quota - The quota name

Returns:

This builder instance for method chaining

credentialsProvider

public MaxStorageClient.Builder credentialsProvider(com.aliyun.credentials.api.ICredentialsProvider credentialsProvider)

Sets the credentials provider for authentication.

Parameters:

credentialsProvider - The credentials provider

Returns:

This builder instance for method chaining

httpSettings

public MaxStorageClient.Builder httpSettings(HttpSettings httpSettings)

Sets the HTTP settings for connection management.

Parameters:

httpSettings - The HTTP settings configuration

Returns:

This builder instance for method chaining

bufferAllocator

public MaxStorageClient.Builder bufferAllocator(org.apache.arrow.memory.BufferAllocator bufferAllocator)

Sets the buffer allocator for memory management.

Parameters:

bufferAllocator - The buffer allocator

Returns:

This builder instance for method chaining

userAgent

public MaxStorageClient.Builder userAgent(String userAgent)

Appends a custom string to the 'User-Agent' header for all MaxStorage requests. Identifying the data source helps in traffic analysis and debugging.

Parameters:

userAgent - The custom user agent string. It will be placed at the end of the standard SDK identifier: JavaSDK/%s (id:%s; revision:%s; java-version:%s; region:%s) [userAgent]

Returns:

This builder instance

build

public MaxStorageClient build()

Builds and returns a new MaxStorageClient instance with the configured settings.

If no tunnel endpoint is explicitly set, this method will attempt to retrieve the tunnel endpoint from the MaxCompute service using the configured endpoint, project, and credentials.

Returns:

A new MaxStorageClient instance