Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetObjectRequest

Hierarchy

  • GetObjectRequest

Properties

bucketName

bucketName: string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

Optional ifMatch

ifMatch: undefined | string

The entity tag (ETag) to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

Optional ifNoneMatch

ifNoneMatch: undefined | string

The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

namespaceName

namespaceName: string

The Object Storage namespace used for the request.

objectName

objectName: string

The name of the object. Avoid entering confidential information. Example: test/object1.log

Optional opcClientRequestId

opcClientRequestId: undefined | string

The client request ID for tracing.

Optional opcSseCustomerAlgorithm

opcSseCustomerAlgorithm: undefined | string

The optional header that specifies "AES256" as the encryption algorithm. For more information, see Using Your Own Keys for Server-Side Encryption.

Optional opcSseCustomerKey

opcSseCustomerKey: undefined | string

The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see Using Your Own Keys for Server-Side Encryption.

Optional opcSseCustomerKeySha256

opcSseCustomerKeySha256: undefined | string

The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. For more information, see Using Your Own Keys for Server-Side Encryption.

Optional range

range: common.Range

Optional byte range to fetch, as described in RFC 7233. Note that only a single range of bytes is supported.

Optional versionId

versionId: undefined | string

VersionId used to identify a particular version of the object