Class ObjectStorageClient
Service client instance for ObjectStorage.
Implements
Inherited Members
Namespace: Oci.ObjectstorageService
Assembly: OCI.DotNetSDK.Objectstorage.dll
Syntax
public class ObjectStorageClient : RegionalClientBase, IDisposable
Constructors
ObjectStorageClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public ObjectStorageClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public ObjectStoragePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ObjectStoragePaginators |
Waiters
Declaration
public ObjectStorageWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ObjectStorageWaiters |
Methods
AbortMultipartUpload(AbortMultipartUploadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
Declaration
public Task<AbortMultipartUploadResponse> AbortMultipartUpload(AbortMultipartUploadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AbortMultipartUploadRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AbortMultipartUploadResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AbortMultipartUpload API.
CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels a work request.
Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CancelWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelWorkRequest API.
CommitMultipartUpload(CommitMultipartUploadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
Declaration
public Task<CommitMultipartUploadResponse> CommitMultipartUpload(CommitMultipartUploadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CommitMultipartUploadRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CommitMultipartUploadResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CommitMultipartUpload API.
CopyObject(CopyObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a request to copy an object within a region or to another region. <br/> See Object Names for object naming requirements.
Declaration
public Task<CopyObjectResponse> CopyObject(CopyObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CopyObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CopyObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CopyObject API.
CreateBucket(CreateBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
Declaration
public Task<CreateBucketResponse> CreateBucket(CreateBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBucket API.
CreateMultipartUpload(CreateMultipartUploadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts a new multipart upload to a specific object in the given bucket in the given namespace. <br/> See Object Names for object naming requirements.
Declaration
public Task<CreateMultipartUploadResponse> CreateMultipartUpload(CreateMultipartUploadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateMultipartUploadRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateMultipartUploadResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateMultipartUpload API.
CreatePreauthenticatedRequest(CreatePreauthenticatedRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a pre-authenticated request specific to the bucket.
Declaration
public Task<CreatePreauthenticatedRequestResponse> CreatePreauthenticatedRequest(CreatePreauthenticatedRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePreauthenticatedRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePreauthenticatedRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePreauthenticatedRequest API.
CreatePrivateEndpoint(CreatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a PrivateEndpoint.
Declaration
public Task<CreatePrivateEndpointResponse> CreatePrivateEndpoint(CreatePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePrivateEndpoint API.
CreateReplicationPolicy(CreateReplicationPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a replication policy for the specified bucket.
Declaration
public Task<CreateReplicationPolicyResponse> CreateReplicationPolicy(CreateReplicationPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateReplicationPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateReplicationPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateReplicationPolicy API.
CreateRetentionRule(CreateRetentionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds. Note that a maximum of 100 rules are supported on a bucket.
Declaration
public Task<CreateRetentionRuleResponse> CreateRetentionRule(CreateRetentionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRetentionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRetentionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRetentionRule API.
DeleteBucket(DeleteBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a bucket if the bucket is already empty. If the bucket is not empty, use {@link #deleteObject(DeleteObjectRequest) deleteObject} first. In addition, you cannot delete a bucket that has a multipart upload in progress or a pre-authenticated request associated with that bucket.
Declaration
public Task<DeleteBucketResponse> DeleteBucket(DeleteBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteBucket API.
DeleteObject(DeleteObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes an object.
Declaration
public Task<DeleteObjectResponse> DeleteObject(DeleteObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteObject API.
DeleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the object lifecycle policy for the bucket.
Declaration
public Task<DeleteObjectLifecyclePolicyResponse> DeleteObjectLifecyclePolicy(DeleteObjectLifecyclePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteObjectLifecyclePolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteObjectLifecyclePolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteObjectLifecyclePolicy API.
DeletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the pre-authenticated request for the bucket.
Declaration
public Task<DeletePreauthenticatedRequestResponse> DeletePreauthenticatedRequest(DeletePreauthenticatedRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePreauthenticatedRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePreauthenticatedRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePreauthenticatedRequest API.
DeletePrivateEndpoint(DeletePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a Private Endpoint if it exists in the given namespace.
Declaration
public Task<DeletePrivateEndpointResponse> DeletePrivateEndpoint(DeletePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePrivateEndpoint API.
DeleteReplicationPolicy(DeleteReplicationPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the replication policy associated with the source bucket.
Declaration
public Task<DeleteReplicationPolicyResponse> DeleteReplicationPolicy(DeleteReplicationPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteReplicationPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteReplicationPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteReplicationPolicy API.
DeleteRetentionRule(DeleteRetentionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified rule. The deletion takes effect typically within 30 seconds.
Declaration
public Task<DeleteRetentionRuleResponse> DeleteRetentionRule(DeleteRetentionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRetentionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteRetentionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRetentionRule API.
GetBucket(GetBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the current representation of the given bucket in the given Object Storage namespace.
Declaration
public Task<GetBucketResponse> GetBucket(GetBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBucket API.
GetNamespace(GetNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace is a system-generated string assigned during account creation. For some older tenancies, the namespace string may be the tenancy name in all lower-case letters. You cannot edit a namespace. <br/> GetNamespace returns the name of the Object Storage namespace for the user making the request. If an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding tenancy, provided the user has access to it.
Declaration
public Task<GetNamespaceResponse> GetNamespace(GetNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNamespace API.
GetNamespaceMetadata(GetNamespaceMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId. <br/> Any user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Declaration
public Task<GetNamespaceMetadataResponse> GetNamespaceMetadata(GetNamespaceMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNamespaceMetadataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNamespaceMetadataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNamespaceMetadata API.
GetObject(GetObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the metadata and body of an object.
Declaration
public Task<GetObjectResponse> GetObject(GetObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetObject API.
GetObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the object lifecycle policy for the bucket.
Declaration
public Task<GetObjectLifecyclePolicyResponse> GetObjectLifecyclePolicy(GetObjectLifecyclePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetObjectLifecyclePolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetObjectLifecyclePolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetObjectLifecyclePolicy API.
GetPreauthenticatedRequest(GetPreauthenticatedRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the pre-authenticated request for the bucket.
Declaration
public Task<GetPreauthenticatedRequestResponse> GetPreauthenticatedRequest(GetPreauthenticatedRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPreauthenticatedRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPreauthenticatedRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPreauthenticatedRequest API.
GetPrivateEndpoint(GetPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the current representation of the given Private Endpoint in the given Object Storage namespace.
Declaration
public Task<GetPrivateEndpointResponse> GetPrivateEndpoint(GetPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPrivateEndpoint API.
GetReplicationPolicy(GetReplicationPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the replication policy.
Declaration
public Task<GetReplicationPolicyResponse> GetReplicationPolicy(GetReplicationPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetReplicationPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetReplicationPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetReplicationPolicy API.
GetRetentionRule(GetRetentionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified retention rule.
Declaration
public Task<GetRetentionRuleResponse> GetRetentionRule(GetRetentionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRetentionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRetentionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRetentionRule API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the work request for the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
HeadBucket(HeadBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
Declaration
public Task<HeadBucketResponse> HeadBucket(HeadBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
HeadBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<HeadBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use HeadBucket API.
HeadObject(HeadObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the user-defined metadata and entity tag (ETag) for an object.
Declaration
public Task<HeadObjectResponse> HeadObject(HeadObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
HeadObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<HeadObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use HeadObject API.
ListBuckets(ListBucketsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket
and does not contain fields like the user-defined metadata.
<br/>
ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned
opc-next-page
value with the page
request parameter.
<br/>
To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,
talk to an administrator. If you are an administrator who needs to write policies to give users access, see
Getting Started with Policies.
Declaration
public Task<ListBucketsResponse> ListBuckets(ListBucketsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBucketsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListBucketsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBuckets API.
ListMultipartUploadParts(ListMultipartUploadPartsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the parts of an in-progress multipart upload.
Declaration
public Task<ListMultipartUploadPartsResponse> ListMultipartUploadParts(ListMultipartUploadPartsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMultipartUploadPartsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListMultipartUploadPartsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMultipartUploadParts API.
ListMultipartUploads(ListMultipartUploadsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
Declaration
public Task<ListMultipartUploadsResponse> ListMultipartUploads(ListMultipartUploadsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMultipartUploadsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListMultipartUploadsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMultipartUploads API.
ListObjectVersions(ListObjectVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the object versions in a bucket.
<br/>
ListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through
more object versions, use the returned opc-next-page
value with the page
request parameter.
<br/>
To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,
talk to an administrator. If you are an administrator who needs to write policies to give users access, see
Getting Started with Policies.
Declaration
public Task<ListObjectVersionsResponse> ListObjectVersions(ListObjectVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListObjectVersionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListObjectVersionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListObjectVersions API.
ListObjects(ListObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the objects in a bucket. By default, ListObjects returns object names only. See the fields
parameter for other fields that you can optionally include in ListObjects response.
<br/>
ListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith'
value with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end'
parameters.
<br/>
To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,
talk to an administrator. If you are an administrator who needs to write policies to give users access, see
Getting Started with Policies.
Declaration
public Task<ListObjectsResponse> ListObjects(ListObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListObjectsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListObjectsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListObjects API.
ListPreauthenticatedRequests(ListPreauthenticatedRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists pre-authenticated requests for the bucket.
Declaration
public Task<ListPreauthenticatedRequestsResponse> ListPreauthenticatedRequests(ListPreauthenticatedRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPreauthenticatedRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPreauthenticatedRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPreauthenticatedRequests API.
ListPrivateEndpoints(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all PrivateEndpointSummary in a compartment associated with a namespace. To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Declaration
public Task<ListPrivateEndpointsResponse> ListPrivateEndpoints(ListPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPrivateEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPrivateEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPrivateEndpoints API.
ListReplicationPolicies(ListReplicationPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List the replication policies associated with a bucket.
Declaration
public Task<ListReplicationPoliciesResponse> ListReplicationPolicies(ListReplicationPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListReplicationPoliciesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListReplicationPoliciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListReplicationPolicies API.
ListReplicationSources(ListReplicationSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List the replication sources of a destination bucket.
Declaration
public Task<ListReplicationSourcesResponse> ListReplicationSources(ListReplicationSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListReplicationSourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListReplicationSourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListReplicationSources API.
ListRetentionRules(ListRetentionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List the retention rules for a bucket. The retention rules are sorted based on creation time, with the most recently created retention rule returned first.
Declaration
public Task<ListRetentionRulesResponse> ListRetentionRules(ListRetentionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRetentionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRetentionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRetentionRules API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the errors of the work request with the given ID.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the logs of the work request with the given ID.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
MakeBucketWritable(MakeBucketWritableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stops replication to the destination bucket and removes the replication policy. When the replication policy was created, this destination bucket became read-only except for new and changed objects replicated automatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no longer the target for replication and is now writable, allowing users to make changes to bucket contents.
Declaration
public Task<MakeBucketWritableResponse> MakeBucketWritable(MakeBucketWritableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
MakeBucketWritableRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<MakeBucketWritableResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use MakeBucketWritable API.
PutObject(PutObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by PutObject is 50 GiB. <br/> See Object Names for object naming requirements. <br/> See Special Instructions for Object Storage PUT for request signature requirements.
Declaration
public Task<PutObjectResponse> PutObject(PutObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PutObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PutObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PutObject API.
PutObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or replaces the object lifecycle policy for the bucket.
Declaration
public Task<PutObjectLifecyclePolicyResponse> PutObjectLifecyclePolicy(PutObjectLifecyclePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PutObjectLifecyclePolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PutObjectLifecyclePolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PutObjectLifecyclePolicy API.
ReencryptBucket(ReencryptBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent version of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master encryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign a key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property of the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management master encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly assigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to a new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated with the bucket, the call will fail. <br/> Calling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only objects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many objects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status of the work request task. All the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket.
Declaration
public Task<ReencryptBucketResponse> ReencryptBucket(ReencryptBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ReencryptBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ReencryptBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ReencryptBucket API.
ReencryptObject(ReencryptObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage service manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for the bucket applies to the objects it contains. <br/> You can alternatively employ one of these encryption strategies for an object: <br/>
- You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service. <br/>
- You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).
Declaration
public Task<ReencryptObjectResponse> ReencryptObject(ReencryptObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ReencryptObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ReencryptObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ReencryptObject API.
RenameObject(RenameObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Rename an object in the given Object Storage namespace. <br/> See Object Names for object naming requirements.
Declaration
public Task<RenameObjectResponse> RenameObject(RenameObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RenameObjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RenameObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RenameObject API.
RestoreObjects(RestoreObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Restores the object specified by the objectName parameter. By default object will be restored for 24 hours. Duration can be configured using the hours parameter.
Declaration
public Task<RestoreObjectsResponse> RestoreObjects(RestoreObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RestoreObjectsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RestoreObjectsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RestoreObjects API.
UpdateBucket(UpdateBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Performs a partial or full update of a bucket's user-defined metadata. <br/> Use UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID of the compartment that you want to move the bucket to. For more information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<UpdateBucketResponse> UpdateBucket(UpdateBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBucket API.
UpdateNamespaceMetadata(UpdateNamespaceMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root compartment of the Oracle Cloud Infrastructure tenancy. <br/> You can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All subsequent bucket creations will use the new default compartment, but no previously created buckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default compartments for Amazon S3 and Swift.
Declaration
public Task<UpdateNamespaceMetadataResponse> UpdateNamespaceMetadata(UpdateNamespaceMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNamespaceMetadataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNamespaceMetadataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNamespaceMetadata API.
UpdateObjectStorageTier(UpdateObjectStorageTierRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the storage tier of the object specified by the objectName parameter.
Declaration
public Task<UpdateObjectStorageTierResponse> UpdateObjectStorageTier(UpdateObjectStorageTierRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateObjectStorageTierRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateObjectStorageTierResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateObjectStorageTier API.
UpdatePrivateEndpoint(UpdatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Performs a partial or full update of a user-defined data associated with the Private Endpoint. <br/> Use UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID of the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint. For more information about moving resources between compartments, see Moving Resources to a Different Compartment. <br/> This API follows replace semantics (rather than merge semantics). That means if the body provides values for parameters and the resource has exisiting ones, this operation will replace those existing values.
Declaration
public Task<UpdatePrivateEndpointResponse> UpdatePrivateEndpoint(UpdatePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePrivateEndpoint API.
UpdateRetentionRule(UpdateRetentionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified retention rule. Rule changes take effect typically within 30 seconds.
Declaration
public Task<UpdateRetentionRuleResponse> UpdateRetentionRule(UpdateRetentionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRetentionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateRetentionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRetentionRule API.
UploadPart(UploadPartRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Uploads a single part of a multipart upload.
Declaration
public Task<UploadPartResponse> UploadPart(UploadPartRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadPartRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadPartResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadPart API.