Class GetObjectRequest

Inheritance

object

GetObjectRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ObjectstorageService.Requests

Assembly: OCI.DotNetSDK.Objectstorage.dll

Syntax

public class GetObjectRequest : IOciRequest

Examples

Click here to see an example of how to use GetObject request.

Properties

BucketName

Declaration

[Required(ErrorMessage = "BucketName is required.")]
[HttpConverter(TargetEnum.Path, "bucketName")]
public string BucketName { get; set; }

Property Value

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

Remarks

Required

HttpResponseCacheControl

Declaration

[HttpConverter(TargetEnum.Query, "httpResponseCacheControl")]
public string HttpResponseCacheControl { get; set; }

Property Value

Type	Description
string	Specify this query parameter to override the Cache-Control response header in the GetObject response.

HttpResponseContentDisposition

Declaration

[HttpConverter(TargetEnum.Query, "httpResponseContentDisposition")]
public string HttpResponseContentDisposition { get; set; }

Property Value

Type	Description
string	Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response.

HttpResponseContentEncoding

Declaration

[HttpConverter(TargetEnum.Query, "httpResponseContentEncoding")]
public string HttpResponseContentEncoding { get; set; }

Property Value

Type	Description
string	Specify this query parameter to override the Content-Encoding response header in the GetObject response.

HttpResponseContentLanguage

Declaration

[HttpConverter(TargetEnum.Query, "httpResponseContentLanguage")]
public string HttpResponseContentLanguage { get; set; }

Property Value

Type	Description
string	Specify this query parameter to override the Content-Language response header in the GetObject response.

HttpResponseContentType

Declaration

[HttpConverter(TargetEnum.Query, "httpResponseContentType")]
public string HttpResponseContentType { get; set; }

Property Value

Type	Description
string	Specify this query parameter to override the Content-Type response header in the GetObject response.

HttpResponseExpires

Declaration

[HttpConverter(TargetEnum.Query, "httpResponseExpires")]
public string HttpResponseExpires { get; set; }

Property Value

Type	Description
string	Specify this query parameter to override the Expires response header in the GetObject response.

IfMatch

Declaration

[HttpConverter(TargetEnum.Header, "if-match")]
public string IfMatch { get; set; }

Property Value

Type	Description
string	The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.

IfNoneMatch

Declaration

[HttpConverter(TargetEnum.Header, "if-none-match")]
public string IfNoneMatch { get; set; }

Property Value

Type	Description
string	The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not match the ETag of the existing resource, the request returns the expected response. If the ETag matches the ETag of the existing resource, the request returns an HTTP 304 status without a response body.

NamespaceName

Declaration

[Required(ErrorMessage = "NamespaceName is required.")]
[HttpConverter(TargetEnum.Path, "namespaceName")]
public string NamespaceName { get; set; }

Property Value

Type	Description
string	The Object Storage namespace used for the request.

Remarks

Required

ObjectName

Declaration

[Required(ErrorMessage = "ObjectName is required.")]
[HttpConverter(TargetEnum.Path, "objectName")]
public string ObjectName { get; set; }

Property Value

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

Remarks

Required

OpcClientRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-client-request-id")]
public string OpcClientRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

OpcSseCustomerAlgorithm

Declaration

[HttpConverter(TargetEnum.Header, "opc-sse-customer-algorithm")]
public string OpcSseCustomerAlgorithm { get; set; }

Property Value

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

OpcSseCustomerKey

Declaration

[HttpConverter(TargetEnum.Header, "opc-sse-customer-key")]
public string OpcSseCustomerKey { get; set; }

Property Value

Type	Description
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.

OpcSseCustomerKeySha256

Declaration

[HttpConverter(TargetEnum.Header, "opc-sse-customer-key-sha256")]
public string OpcSseCustomerKeySha256 { get; set; }

Property Value

Type	Description
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.

Range

Declaration

[HttpConverter(TargetEnum.Header, "range")]
public Range Range { get; set; }

Property Value

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

VersionId

Declaration

[HttpConverter(TargetEnum.Query, "versionId")]
public string VersionId { get; set; }

Property Value

Type	Description
string	VersionId used to identify a particular version of the object

Implements

IOciRequest