Get Object

Updated at：2025-11-03

Simple object get

Users can load the object into a stream by using the following code.

Basic workflow

Instantiate the BOSClient class.
By calling the BOSClient.getObject() method, the specified BosObject will be returned.
Load the BosObject into a stream for further processing.

Example code

                Java
                
            

                //Obtain the object, with returned result BosObject object
BosObject object = client.getObject(<BucketName>, <ObjectKey>);
 // Retrieve ObjectMeta
ObjectMetadata meta = object.getObjectMetadata();
 //Obtain the object's input stream
InputStream objectContent = object.getObjectContent();
 // Process object
...
 // Close stream
objectContent.close();
            

Note:

The BosObject includes various details about the object, such as the bucket it belongs to, the object’s name, metadata, and an input stream. Users can read the object's content into a file or memory by interacting with the input stream.

ObjectMetadata contains information such as the ETag defined during object upload, HTTP headers, and custom metadata.

Using the getObjectContent() method of BosObject, users can access the input stream of the returned object, enabling them to read and process the object's content.

Complete example

                Java
                
            

                import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import android.app.Activity;
import android.os.Bundle;
import com.baidubce.BceClientException;
import com.baidubce.BceServiceException;
import com.baidubce.auth.DefaultBceCredentials;
import com.baidubce.demo.R;
import com.baidubce.services.bos.BosClient;
import com.baidubce.services.bos.BosClientConfiguration;
import com.baidubce.services.bos.model.BosObject;
import com.baidubce.services.bos.model.ObjectMetadata;
public class ExampleActivity extends Activity {
private String bucketName = <BucketName>;
private String objectKey = <ObjectKey>;
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    new Thread(new Runnable() {
        @Override
        public void run() {
            try {
                BosClientConfiguration config = new BosClientConfiguration();
                config.setCredentials(new DefaultBceCredentials(<AccessKeyID>, <SecretAccessKey>));
                config.setEndpoint(<EndPoint>);
                BosClient client = new BosClient(config);
 //Obtain the object, with returned result BosObject object
                BosObject object = client.getObject(<BucketName>, <ObjectKey>);
 // Retrieve ObjectMeta
                ObjectMetadata meta = object.getObjectMetadata();
 //Obtain the object's input stream
                InputStream objectContent = object.getObjectContent();
 // Process object
                FileOutputStream fos=new FileOutputStream(android.os.Environment.getExternalStorageDirectory()+"/1/file");  
                byte[] buffer=new byte[<bufferSize>];  
                int count=0;  
                while ((count=objectContent.read(buffer))>=0) {  
                    fos.write(buffer,0,count);  
                }  
                System.out.println(meta.getETag());
                System.out.println(meta.getContentLength());
 // Close stream
                objectContent.close();
                fos.close();
            } catch (BceServiceException e) {
                System.out.println("Error ErrorCode: " + e.getErrorCode());
                System.out.println("Error RequestId: " + e.getRequestId());
                System.out.println("Error StatusCode: " + e.getStatusCode());
                System.out.println("Error Message: " + e.getMessage());
                System.out.println("Error ErrorType: " + e.getErrorType());
            } catch (BceClientException e) {
                System.out.println("Error Message: " + e.getMessage());
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
    }).start();
}}
            

Obtain object via GetObjectRequest

To unlock more capabilities, GetObjectRequest can be used to retrieve objects.

Basic workflow

Create an instance of the GetObjectRequest class.
Invoke the setRange() method on GetObjectRequest to retrieve specific byte ranges from the object.
Execute the client.getObject() operation.

Example code

                Java
                
            

                // Create GetObjectRequest
GetObjectRequest getObjectRequest = new GetObjectRequest(<BucketName>, <ObjectKey>);
 // Obtain data within the 0~100 byte range
getObjectRequest.setRange(0, 100);
 //Obtain the object, with returned result BosObject object
BosObject object = client.getObject(getObjectRequest);
            

Note: The setRange() method in GetObjectRequest allows users to specify a range for the returned object. This feature can be used to implement segmented downloads and resumable uploads.

Obtain download progress

Users can track download progress via a callback function.

The SDK offers a download progress callback API, which allows you to define necessary operations during the upload process, such as updating the API.

                Java
                
            

                public interface BceProgressCallback<T extends AbstractBceRequest> {
 // request is the download request
 // currentSize is the current download size (unit: byte)
 // totalSize is the total size to be downloaded in this request (unit: byte)
          void onProgress(T request, long currentSize, long totalSize);
    ｝
            

Example code

                Java
                
            

                GetObjectRequest request = new GetObjectRequest()
        .withBucketName(this.bucketName)
        .withKey(objectKey)
        .withRange(0, 5);
request.setProgressCallback(new BosProgressCallback<GetObjectRequest>() {
    @Override
    public void onProgress(GetObjectRequest request, long currentSize, long totalSize) {
        Log.e(currentSize + "", totalSize + "");
    }
});
InputStream input = this.client.getObject(request).getObjectContent();
            

Note: The download progress interface differs from the upload progress interface. It is not possible to specify the fragment size of the increase in the download volume during each callback.

Download object to a specified path

Users can use the following code to directly download an object to a specified path.

Basic workflow

Create an instance of the GetObjectRequest class.
Execute the client.getObject() operation.
Download an object directly to a specified path.

Example code

                Java
                
                // Create GetObjectRequest
GetObjectRequest getObjectRequest = new GetObjectRequest(<BucketName>, <ObjectKey>);
 // Download object to file
ObjectMetadata objectMetadata = client.getObject(getObjectRequest, new File("/path/to/file","w+"));

Note: When using the above method to directly download an object to a specified path, the method returns an ObjectMetadata object.

Obtain the storageClass of an object

The storage classes of an object are categorized as STANDARD (standard storage), STANDARD_IA (infrequent access storage), COLD (cold storage), and ARCHIVE (archive storage).

Example code

                Java
                
            

                public void getObjectStorageClass(){
  //...
ObjectMetadata meta = client.getObjectMetadata(bucketName, key);
String storageClass = meta.getStorageClass();
}
            

Obtain only ObjectMetadata

The getObjectMetadata() method retrieves only the ObjectMetadata, without obtaining the object itself.

Example code

                Java
                
                ObjectMetadata objectMetadata = client.getObjectMetadata(<BucketName>, <ObjectKey>);

Get object URL

The following code allows you to get the URL of a specific object, which is commonly used for temporarily sharing the object's URL with others.

Basic workflow

Instantiate the BOSClient class.
Call the BOSClient.generatePresignedUrl() method.
The method returns the URL of the object.

Example code

                Java
                
                URL url = client.generatePresignedUrl(<BucketName>, <ObjectKey>, <ExpirationInSeconds>);

Note:ExpirationInSeconds is the specified URL validity period, calculated from the current time. It is an optional parameter, and the system default value is 1,800 s if not configured. To set a permanent non-expiration time, the ExpirationInSeconds parameter can be set to -1. You cannot set it to any other negative value.

Complete example

                Java
                
            

                import java.net.URL;
import android.app.Activity;
import android.content.Intent;
import android.net.Uri;
import android.os.Bundle;
import com.baidubce.BceClientException;
import com.baidubce.BceServiceException;
import com.baidubce.auth.DefaultBceCredentials;
import com.baidubce.demo.R;
import com.baidubce.services.bos.BosClient;
import com.baidubce.services.bos.BosClientConfiguration;
public class ExampleActivity extends Activity {
private String bucketName = <BucketName>;
private String objectKey = <ObjectKey>;
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    new Thread(new Runnable() {
        @Override
        public void run() {
            try {
                BosClientConfiguration config = new BosClientConfiguration();
                config.setCredentials(new DefaultBceCredentials(<AccessKeyID>, <SecretAccessKey>));
                config.setEndpoint(<EndPoint>);
                BosClient client = new BosClient(config);
 //Obtain the object URL
                URL url = client.generatePresignedUrl(<BucketName>, <ObjectKey>, 2000);  
                Uri uri = Uri.parse(url.toString());
                Intent intent = new Intent(Intent.ACTION_VIEW, uri);
 // Execute URL
                startActivity(intent);
            } catch (BceServiceException e) {
                System.out.println("Error ErrorCode: " + e.getErrorCode());
                System.out.println("Error RequestId: " + e.getRequestId());
                System.out.println("Error StatusCode: " + e.getStatusCode());
                System.out.println("Error Message: " + e.getMessage());
                System.out.println("Error ErrorType: " + e.getErrorType());
            } catch (BceClientException e) {
                System.out.println("Error Message: " + e.getMessage());
            }
        }
    }).start();
}}
            

Multipart upload of objects

View the object in the bucket

BOS

BOS

Get Object

Simple object get

Basic workflow

Example code

Complete example

Obtain object via GetObjectRequest

Basic workflow

Example code

Obtain download progress

Example code

Download object to a specified path

Basic workflow

Example code

Obtain the storageClass of an object

Example code

Obtain only ObjectMetadata

Example code

Get object URL

Basic workflow

Example code

Complete example