Class HeadObjectRequest
Implements
Inherited Members
Namespace: Oci.ObjectstorageService.Requests
Assembly: OCI.DotNetSDK.Objectstorage.dll
Syntax
public class HeadObjectRequest : IOciRequest
Examples
Click here to see an example of how to use HeadObject 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
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. |
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 |