Class: OCI::ObjectStorage::ObjectStorageClient
- Inherits:
-
Object
- Object
- OCI::ObjectStorage::ObjectStorageClient
- Defined in:
- lib/oci/object_storage/object_storage_client.rb
Overview
Use Object Storage and Archive Storage APIs to manage buckets, objects, and related resources. For more information, see Overview of Object Storage and Overview of Archive Storage.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#abort_multipart_upload(namespace_name, bucket_name, object_name, upload_id, opts = {}) ⇒ Response
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
-
#cancel_work_request(work_request_id, opts = {}) ⇒ Response
Cancels a work request.
-
#commit_multipart_upload(namespace_name, bucket_name, object_name, upload_id, commit_multipart_upload_details, opts = {}) ⇒ Response
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
-
#copy_object(namespace_name, bucket_name, copy_object_details, opts = {}) ⇒ Response
Creates a request to copy an object within a region or to another region.
-
#create_bucket(namespace_name, create_bucket_details, opts = {}) ⇒ Response
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata.
-
#create_multipart_upload(namespace_name, bucket_name, create_multipart_upload_details, opts = {}) ⇒ Response
Starts a new multipart upload to a specific object in the given bucket in the given namespace.
-
#create_preauthenticated_request(namespace_name, bucket_name, create_preauthenticated_request_details, opts = {}) ⇒ Response
Creates a pre-authenticated request specific to the bucket.
-
#create_replication_policy(namespace_name, bucket_name, create_replication_policy_details, opts = {}) ⇒ Response
Creates a replication policy for the specified bucket.
-
#create_retention_rule(namespace_name, bucket_name, create_retention_rule_details, opts = {}) ⇒ Response
Creates a new retention rule in the specified bucket.
-
#delete_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Deletes a bucket if the bucket is already empty.
-
#delete_object(namespace_name, bucket_name, object_name, opts = {}) ⇒ Response
Deletes an object.
-
#delete_object_lifecycle_policy(namespace_name, bucket_name, opts = {}) ⇒ Response
Deletes the object lifecycle policy for the bucket.
-
#delete_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) ⇒ Response
Deletes the pre-authenticated request for the bucket.
-
#delete_replication_policy(namespace_name, bucket_name, replication_id, opts = {}) ⇒ Response
Deletes the replication policy associated with the source bucket.
-
#delete_retention_rule(namespace_name, bucket_name, retention_rule_id, opts = {}) ⇒ Response
Deletes the specified rule.
-
#get_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Gets the current representation of the given bucket in the given Object Storage namespace.
-
#get_namespace(opts = {}) ⇒ Response
Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace.
-
#get_namespace_metadata(namespace_name, opts = {}) ⇒ Response
Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId.
-
#get_object(namespace_name, bucket_name, object_name, opts = {}, &block) ⇒ Response
Gets the metadata and body of an object.
-
#get_object_lifecycle_policy(namespace_name, bucket_name, opts = {}) ⇒ Response
Gets the object lifecycle policy for the bucket.
-
#get_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) ⇒ Response
Gets the pre-authenticated request for the bucket.
-
#get_replication_policy(namespace_name, bucket_name, replication_id, opts = {}) ⇒ Response
Get the replication policy.
-
#get_retention_rule(namespace_name, bucket_name, retention_rule_id, opts = {}) ⇒ Response
Get the specified retention rule.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the status of the work request for the given ID.
-
#head_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
-
#head_object(namespace_name, bucket_name, object_name, opts = {}) ⇒ Response
Gets the user-defined metadata and entity tag (ETag) for an object.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ObjectStorageClient
constructor
Creates a new ObjectStorageClient.
-
#list_buckets(namespace_name, compartment_id, opts = {}) ⇒ Response
Gets a list of all BucketSummary items in a compartment.
-
#list_multipart_upload_parts(namespace_name, bucket_name, object_name, upload_id, opts = {}) ⇒ Response
Lists the parts of an in-progress multipart upload.
-
#list_multipart_uploads(namespace_name, bucket_name, opts = {}) ⇒ Response
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
-
#list_object_versions(namespace_name, bucket_name, opts = {}) ⇒ Response
Lists the object versions in a bucket.
-
#list_objects(namespace_name, bucket_name, opts = {}) ⇒ Response
Lists the objects in a bucket.
-
#list_preauthenticated_requests(namespace_name, bucket_name, opts = {}) ⇒ Response
Lists pre-authenticated requests for the bucket.
-
#list_replication_policies(namespace_name, bucket_name, opts = {}) ⇒ Response
List the replication policies associated with a bucket.
-
#list_replication_sources(namespace_name, bucket_name, opts = {}) ⇒ Response
List the replication sources of a destination bucket.
-
#list_retention_rules(namespace_name, bucket_name, opts = {}) ⇒ Response
List the retention rules for a bucket.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Lists the errors of the work request with the given ID.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Lists the logs of the work request with the given ID.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#make_bucket_writable(namespace_name, bucket_name, opts = {}) ⇒ Response
Stops replication to the destination bucket and removes the replication policy.
-
#put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) ⇒ Response
Creates a new object or overwrites an existing object with the same name.
-
#put_object_lifecycle_policy(namespace_name, bucket_name, put_object_lifecycle_policy_details, opts = {}) ⇒ Response
Creates or replaces the object lifecycle policy for the bucket.
-
#reencrypt_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
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.
-
#reencrypt_object(namespace_name, bucket_name, object_name, reencrypt_object_details, opts = {}) ⇒ Response
Re-encrypts the data encryption keys that encrypt the object and its chunks.
-
#rename_object(namespace_name, bucket_name, rename_object_details, opts = {}) ⇒ Response
Rename an object in the given Object Storage namespace.
-
#restore_objects(namespace_name, bucket_name, restore_objects_details, opts = {}) ⇒ Response
Restores one or more objects specified by the objectName parameter.
-
#update_bucket(namespace_name, bucket_name, update_bucket_details, opts = {}) ⇒ Response
Performs a partial or full update of a bucket's user-defined metadata.
-
#update_namespace_metadata(namespace_name, update_namespace_metadata_details, opts = {}) ⇒ Response
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.
-
#update_object_storage_tier(namespace_name, bucket_name, update_object_storage_tier_details, opts = {}) ⇒ Response
Changes the storage tier of the object specified by the objectName parameter.
-
#update_retention_rule(namespace_name, bucket_name, retention_rule_id, update_retention_rule_details, opts = {}) ⇒ Response
Updates the specified retention rule.
-
#upload_part(namespace_name, bucket_name, object_name, upload_id, upload_part_num, upload_part_body, opts = {}) ⇒ Response
Uploads a single part of a multipart upload.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ObjectStorageClient
Creates a new ObjectStorageClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 57 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ObjectStorageClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
17 18 19 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 17 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
21 22 23 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 21 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
31 32 33 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 31 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
27 28 29 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 27 def retry_config @retry_config end |
Instance Method Details
#abort_multipart_upload(namespace_name, bucket_name, object_name, upload_id, opts = {}) ⇒ Response
Click here to see an example of how to use abort_multipart_upload API.
Aborts an in-progress multipart upload and deletes all parts that have been uploaded.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 121 def abort_multipart_upload(namespace_name, bucket_name, object_name, upload_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#abort_multipart_upload.' if logger raise "Missing the required parameter 'namespace_name' when calling abort_multipart_upload." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling abort_multipart_upload." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling abort_multipart_upload." if object_name.nil? raise "Missing the required parameter 'upload_id' when calling abort_multipart_upload." if upload_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/u/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:uploadId] = upload_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#abort_multipart_upload') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#cancel_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use cancel_work_request API.
Cancels a work request.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 181 def cancel_work_request(work_request_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#cancel_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling cancel_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#cancel_work_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#commit_multipart_upload(namespace_name, bucket_name, object_name, upload_id, commit_multipart_upload_details, opts = {}) ⇒ Response
Click here to see an example of how to use commit_multipart_upload API.
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 250 def commit_multipart_upload(namespace_name, bucket_name, object_name, upload_id, commit_multipart_upload_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#commit_multipart_upload.' if logger raise "Missing the required parameter 'namespace_name' when calling commit_multipart_upload." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling commit_multipart_upload." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling commit_multipart_upload." if object_name.nil? raise "Missing the required parameter 'upload_id' when calling commit_multipart_upload." if upload_id.nil? raise "Missing the required parameter 'commit_multipart_upload_details' when calling commit_multipart_upload." if commit_multipart_upload_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/u/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:uploadId] = upload_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(commit_multipart_upload_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#commit_multipart_upload') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#copy_object(namespace_name, bucket_name, copy_object_details, opts = {}) ⇒ Response
Click here to see an example of how to use copy_object API.
Creates a request to copy an object within a region or to another region.
See Object Names for object naming requirements.
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 347 def copy_object(namespace_name, bucket_name, copy_object_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#copy_object.' if logger raise "Missing the required parameter 'namespace_name' when calling copy_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling copy_object." if bucket_name.nil? raise "Missing the required parameter 'copy_object_details' when calling copy_object." if copy_object_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/actions/copyObject'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:'opc-sse-customer-algorithm'] = opts[:opc_sse_customer_algorithm] if opts[:opc_sse_customer_algorithm] header_params[:'opc-sse-customer-key'] = opts[:opc_sse_customer_key] if opts[:opc_sse_customer_key] header_params[:'opc-sse-customer-key-sha256'] = opts[:opc_sse_customer_key_sha256] if opts[:opc_sse_customer_key_sha256] header_params[:'opc-source-sse-customer-algorithm'] = opts[:opc_source_sse_customer_algorithm] if opts[:opc_source_sse_customer_algorithm] header_params[:'opc-source-sse-customer-key'] = opts[:opc_source_sse_customer_key] if opts[:opc_source_sse_customer_key] header_params[:'opc-source-sse-customer-key-sha256'] = opts[:opc_source_sse_customer_key_sha256] if opts[:opc_source_sse_customer_key_sha256] header_params[:'opc-sse-kms-key-id'] = opts[:opc_sse_kms_key_id] if opts[:opc_sse_kms_key_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(copy_object_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#copy_object') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_bucket(namespace_name, create_bucket_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_bucket API.
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 413 def create_bucket(namespace_name, create_bucket_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#create_bucket.' if logger raise "Missing the required parameter 'namespace_name' when calling create_bucket." if namespace_name.nil? raise "Missing the required parameter 'create_bucket_details' when calling create_bucket." if create_bucket_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) path = '/n/{namespaceName}/b/'.sub('{namespaceName}', namespace_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_bucket_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#create_bucket') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::Bucket' ) end # rubocop:enable Metrics/BlockLength end |
#create_multipart_upload(namespace_name, bucket_name, create_multipart_upload_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_multipart_upload API.
Starts a new multipart upload to a specific object in the given bucket in the given namespace.
See Object Names for object naming requirements.
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 497 def create_multipart_upload(namespace_name, bucket_name, create_multipart_upload_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#create_multipart_upload.' if logger raise "Missing the required parameter 'namespace_name' when calling create_multipart_upload." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling create_multipart_upload." if bucket_name.nil? raise "Missing the required parameter 'create_multipart_upload_details' when calling create_multipart_upload." if create_multipart_upload_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/u'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:'opc-sse-customer-algorithm'] = opts[:opc_sse_customer_algorithm] if opts[:opc_sse_customer_algorithm] header_params[:'opc-sse-customer-key'] = opts[:opc_sse_customer_key] if opts[:opc_sse_customer_key] header_params[:'opc-sse-customer-key-sha256'] = opts[:opc_sse_customer_key_sha256] if opts[:opc_sse_customer_key_sha256] header_params[:'opc-sse-kms-key-id'] = opts[:opc_sse_kms_key_id] if opts[:opc_sse_kms_key_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_multipart_upload_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#create_multipart_upload') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::MultipartUpload' ) end # rubocop:enable Metrics/BlockLength end |
#create_preauthenticated_request(namespace_name, bucket_name, create_preauthenticated_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_preauthenticated_request API.
Creates a pre-authenticated request specific to the bucket.
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 565 def create_preauthenticated_request(namespace_name, bucket_name, create_preauthenticated_request_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#create_preauthenticated_request.' if logger raise "Missing the required parameter 'namespace_name' when calling create_preauthenticated_request." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling create_preauthenticated_request." if bucket_name.nil? raise "Missing the required parameter 'create_preauthenticated_request_details' when calling create_preauthenticated_request." if create_preauthenticated_request_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/p/'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_preauthenticated_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#create_preauthenticated_request') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::PreauthenticatedRequest' ) end # rubocop:enable Metrics/BlockLength end |
#create_replication_policy(namespace_name, bucket_name, create_replication_policy_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_replication_policy API.
Creates a replication policy for the specified bucket.
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 627 def create_replication_policy(namespace_name, bucket_name, create_replication_policy_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#create_replication_policy.' if logger raise "Missing the required parameter 'namespace_name' when calling create_replication_policy." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling create_replication_policy." if bucket_name.nil? raise "Missing the required parameter 'create_replication_policy_details' when calling create_replication_policy." if create_replication_policy_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/replicationPolicies'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_replication_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#create_replication_policy') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::ReplicationPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#create_retention_rule(namespace_name, bucket_name, create_retention_rule_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_retention_rule API.
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.
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 690 def create_retention_rule(namespace_name, bucket_name, create_retention_rule_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#create_retention_rule.' if logger raise "Missing the required parameter 'namespace_name' when calling create_retention_rule." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling create_retention_rule." if bucket_name.nil? raise "Missing the required parameter 'create_retention_rule_details' when calling create_retention_rule." if create_retention_rule_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/retentionRules'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(create_retention_rule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#create_retention_rule') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::RetentionRule' ) end # rubocop:enable Metrics/BlockLength end |
#delete_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use delete_bucket API.
Deletes a bucket if the bucket is already empty. If the bucket is not empty, use delete_object first. In addition, you cannot delete a bucket that has a multipart upload in progress or a pre-authenticated request associated with that bucket.
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 758 def delete_bucket(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#delete_bucket.' if logger raise "Missing the required parameter 'namespace_name' when calling delete_bucket." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling delete_bucket." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#delete_bucket') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_object(namespace_name, bucket_name, object_name, opts = {}) ⇒ Response
Click here to see an example of how to use delete_object API.
Deletes an object.
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 826 def delete_object(namespace_name, bucket_name, object_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#delete_object.' if logger raise "Missing the required parameter 'namespace_name' when calling delete_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling delete_object." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling delete_object." if object_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/o/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:versionId] = opts[:version_id] if opts[:version_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#delete_object') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_object_lifecycle_policy(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use delete_object_lifecycle_policy API.
Deletes the object lifecycle policy for the bucket.
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 893 def delete_object_lifecycle_policy(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#delete_object_lifecycle_policy.' if logger raise "Missing the required parameter 'namespace_name' when calling delete_object_lifecycle_policy." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling delete_object_lifecycle_policy." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/l'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#delete_object_lifecycle_policy') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_preauthenticated_request API.
Deletes the pre-authenticated request for the bucket.
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 955 def delete_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#delete_preauthenticated_request.' if logger raise "Missing the required parameter 'namespace_name' when calling delete_preauthenticated_request." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling delete_preauthenticated_request." if bucket_name.nil? raise "Missing the required parameter 'par_id' when calling delete_preauthenticated_request." if par_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'par_id' must not be blank" if OCI::Internal::Util.blank_string?(par_id) path = '/n/{namespaceName}/b/{bucketName}/p/{parId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{parId}', par_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#delete_preauthenticated_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_replication_policy(namespace_name, bucket_name, replication_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_replication_policy API.
Deletes the replication policy associated with the source bucket.
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1017 def delete_replication_policy(namespace_name, bucket_name, replication_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#delete_replication_policy.' if logger raise "Missing the required parameter 'namespace_name' when calling delete_replication_policy." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling delete_replication_policy." if bucket_name.nil? raise "Missing the required parameter 'replication_id' when calling delete_replication_policy." if replication_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'replication_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_id) path = '/n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{replicationId}', replication_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#delete_replication_policy') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_retention_rule(namespace_name, bucket_name, retention_rule_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_retention_rule API.
Deletes the specified rule. The deletion takes effect typically within 30 seconds.
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1082 def delete_retention_rule(namespace_name, bucket_name, retention_rule_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#delete_retention_rule.' if logger raise "Missing the required parameter 'namespace_name' when calling delete_retention_rule." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling delete_retention_rule." if bucket_name.nil? raise "Missing the required parameter 'retention_rule_id' when calling delete_retention_rule." if retention_rule_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'retention_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(retention_rule_id) path = '/n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{retentionRuleId}', retention_rule_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#delete_retention_rule') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_bucket API.
Gets the current representation of the given bucket in the given Object Storage namespace.
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1158 def get_bucket(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_bucket.' if logger raise "Missing the required parameter 'namespace_name' when calling get_bucket." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling get_bucket." if bucket_name.nil? fields_allowable_values = %w[approximateCount approximateSize autoTiering] if opts[:fields] && !opts[:fields].empty? opts[:fields].each do |val_to_check| unless fields_allowable_values.include?(val_to_check) raise 'Invalid value for "fields", must be one of approximateCount, approximateSize, autoTiering.' end end end raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :csv) if opts[:fields] && !opts[:fields].empty? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_bucket') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::Bucket' ) end # rubocop:enable Metrics/BlockLength end |
#get_namespace(opts = {}) ⇒ Response
Click here to see an example of how to use get_namespace API.
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.
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.
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1236 def get_namespace(opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_namespace.' if logger path = '/n/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_namespace') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end # rubocop:enable Metrics/BlockLength end |
#get_namespace_metadata(namespace_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_namespace_metadata API.
Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId.
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.
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1296 def (namespace_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_namespace_metadata.' if logger raise "Missing the required parameter 'namespace_name' when calling get_namespace_metadata." if namespace_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) path = '/n/{namespaceName}'.sub('{namespaceName}', namespace_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_namespace_metadata') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::NamespaceMetadata' ) end # rubocop:enable Metrics/BlockLength end |
#get_object(namespace_name, bucket_name, object_name, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_object API.
Gets the metadata and body of an object.
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1388 def get_object(namespace_name, bucket_name, object_name, opts = {}, &block) logger.debug 'Calling operation ObjectStorageClient#get_object.' if logger raise "Missing the required parameter 'namespace_name' when calling get_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling get_object." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling get_object." if object_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/o/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:versionId] = opts[:version_id] if opts[:version_id] query_params[:httpResponseContentDisposition] = opts[:http_response_content_disposition] if opts[:http_response_content_disposition] query_params[:httpResponseCacheControl] = opts[:http_response_cache_control] if opts[:http_response_cache_control] query_params[:httpResponseContentType] = opts[:http_response_content_type] if opts[:http_response_content_type] query_params[:httpResponseContentLanguage] = opts[:http_response_content_language] if opts[:http_response_content_language] query_params[:httpResponseContentEncoding] = opts[:http_response_content_encoding] if opts[:http_response_content_encoding] query_params[:httpResponseExpires] = opts[:http_response_expires] if opts[:http_response_expires] # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/json' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:range] = opts[:range] if opts[:range] header_params[:'opc-sse-customer-algorithm'] = opts[:opc_sse_customer_algorithm] if opts[:opc_sse_customer_algorithm] header_params[:'opc-sse-customer-key'] = opts[:opc_sse_customer_key] if opts[:opc_sse_customer_key] header_params[:'opc-sse-customer-key-sha256'] = opts[:opc_sse_customer_key_sha256] if opts[:opc_sse_customer_key_sha256] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_object') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_object_lifecycle_policy(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_object_lifecycle_policy API.
Gets the object lifecycle policy for the bucket.
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1507 def get_object_lifecycle_policy(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_object_lifecycle_policy.' if logger raise "Missing the required parameter 'namespace_name' when calling get_object_lifecycle_policy." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling get_object_lifecycle_policy." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/l'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_object_lifecycle_policy') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::ObjectLifecyclePolicy' ) end # rubocop:enable Metrics/BlockLength end |
#get_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_preauthenticated_request API.
Gets the pre-authenticated request for the bucket.
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1569 def get_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_preauthenticated_request.' if logger raise "Missing the required parameter 'namespace_name' when calling get_preauthenticated_request." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling get_preauthenticated_request." if bucket_name.nil? raise "Missing the required parameter 'par_id' when calling get_preauthenticated_request." if par_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'par_id' must not be blank" if OCI::Internal::Util.blank_string?(par_id) path = '/n/{namespaceName}/b/{bucketName}/p/{parId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{parId}', par_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_preauthenticated_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::PreauthenticatedRequestSummary' ) end # rubocop:enable Metrics/BlockLength end |
#get_replication_policy(namespace_name, bucket_name, replication_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_replication_policy API.
Get the replication policy.
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1632 def get_replication_policy(namespace_name, bucket_name, replication_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_replication_policy.' if logger raise "Missing the required parameter 'namespace_name' when calling get_replication_policy." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling get_replication_policy." if bucket_name.nil? raise "Missing the required parameter 'replication_id' when calling get_replication_policy." if replication_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'replication_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_id) path = '/n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{replicationId}', replication_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_replication_policy') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::ReplicationPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#get_retention_rule(namespace_name, bucket_name, retention_rule_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_retention_rule API.
Get the specified retention rule.
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1694 def get_retention_rule(namespace_name, bucket_name, retention_rule_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_retention_rule.' if logger raise "Missing the required parameter 'namespace_name' when calling get_retention_rule." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling get_retention_rule." if bucket_name.nil? raise "Missing the required parameter 'retention_rule_id' when calling get_retention_rule." if retention_rule_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'retention_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(retention_rule_id) path = '/n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{retentionRuleId}', retention_rule_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_retention_rule') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::RetentionRule' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Gets the status of the work request for the given ID.
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1752 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#get_work_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#head_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use head_bucket API.
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1818 def head_bucket(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#head_bucket.' if logger raise "Missing the required parameter 'namespace_name' when calling head_bucket." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling head_bucket." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#head_bucket') do @api_client.call_api( :HEAD, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#head_object(namespace_name, bucket_name, object_name, opts = {}) ⇒ Response
Click here to see an example of how to use head_object API.
Gets the user-defined metadata and entity tag (ETag) for an object.
1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1902 def head_object(namespace_name, bucket_name, object_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#head_object.' if logger raise "Missing the required parameter 'namespace_name' when calling head_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling head_object." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling head_object." if object_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/o/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:versionId] = opts[:version_id] if opts[:version_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:'opc-sse-customer-algorithm'] = opts[:opc_sse_customer_algorithm] if opts[:opc_sse_customer_algorithm] header_params[:'opc-sse-customer-key'] = opts[:opc_sse_customer_key] if opts[:opc_sse_customer_key] header_params[:'opc-sse-customer-key-sha256'] = opts[:opc_sse_customer_key_sha256] if opts[:opc_sse_customer_key_sha256] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#head_object') do @api_client.call_api( :HEAD, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#list_buckets(namespace_name, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_buckets API.
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.
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.
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.
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1986 def list_buckets(namespace_name, compartment_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_buckets.' if logger raise "Missing the required parameter 'namespace_name' when calling list_buckets." if namespace_name.nil? raise "Missing the required parameter 'compartment_id' when calling list_buckets." if compartment_id.nil? fields_allowable_values = %w[tags] if opts[:fields] && !opts[:fields].empty? opts[:fields].each do |val_to_check| unless fields_allowable_values.include?(val_to_check) raise 'Invalid value for "fields", must be one of tags.' end end end raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) path = '/n/{namespaceName}/b/'.sub('{namespaceName}', namespace_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :csv) if opts[:fields] && !opts[:fields].empty? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_buckets') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::BucketSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_multipart_upload_parts(namespace_name, bucket_name, object_name, upload_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_multipart_upload_parts API.
Lists the parts of an in-progress multipart upload.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2070 def list_multipart_upload_parts(namespace_name, bucket_name, object_name, upload_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_multipart_upload_parts.' if logger raise "Missing the required parameter 'namespace_name' when calling list_multipart_upload_parts." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_multipart_upload_parts." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling list_multipart_upload_parts." if object_name.nil? raise "Missing the required parameter 'upload_id' when calling list_multipart_upload_parts." if upload_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/u/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:uploadId] = upload_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_multipart_upload_parts') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::MultipartUploadPartSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_multipart_uploads(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_multipart_uploads API.
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2143 def list_multipart_uploads(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_multipart_uploads.' if logger raise "Missing the required parameter 'namespace_name' when calling list_multipart_uploads." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_multipart_uploads." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/u'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_multipart_uploads') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::MultipartUpload>' ) end # rubocop:enable Metrics/BlockLength end |
#list_object_versions(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_object_versions API.
Lists the object versions in a bucket.
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.
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.
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2236 def list_object_versions(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_object_versions.' if logger raise "Missing the required parameter 'namespace_name' when calling list_object_versions." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_object_versions." if bucket_name.nil? if opts[:fields] && !%w[name size etag timeCreated md5 timeModified storageTier archivalState].include?(opts[:fields]) raise 'Invalid value for "fields", must be one of name, size, etag, timeCreated, md5, timeModified, storageTier, archivalState.' end raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/objectversions'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:prefix] = opts[:prefix] if opts[:prefix] query_params[:start] = opts[:start] if opts[:start] query_params[:end] = opts[:_end] if opts[:_end] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:delimiter] = opts[:delimiter] if opts[:delimiter] query_params[:fields] = opts[:fields] if opts[:fields] query_params[:startAfter] = opts[:start_after] if opts[:start_after] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_object_versions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::ObjectVersionCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_objects(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_objects API.
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.
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.
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.
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2337 def list_objects(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_objects.' if logger raise "Missing the required parameter 'namespace_name' when calling list_objects." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_objects." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/o'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:prefix] = opts[:prefix] if opts[:prefix] query_params[:start] = opts[:start] if opts[:start] query_params[:end] = opts[:_end] if opts[:_end] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:delimiter] = opts[:delimiter] if opts[:delimiter] query_params[:fields] = opts[:fields] if opts[:fields] query_params[:startAfter] = opts[:start_after] if opts[:start_after] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_objects') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::ListObjects' ) end # rubocop:enable Metrics/BlockLength end |
#list_preauthenticated_requests(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_preauthenticated_requests API.
Lists pre-authenticated requests for the bucket.
2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2412 def list_preauthenticated_requests(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_preauthenticated_requests.' if logger raise "Missing the required parameter 'namespace_name' when calling list_preauthenticated_requests." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_preauthenticated_requests." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/p/'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:objectNamePrefix] = opts[:object_name_prefix] if opts[:object_name_prefix] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_preauthenticated_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::PreauthenticatedRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_replication_policies(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_replication_policies API.
List the replication policies associated with a bucket.
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2482 def list_replication_policies(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_replication_policies.' if logger raise "Missing the required parameter 'namespace_name' when calling list_replication_policies." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_replication_policies." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/replicationPolicies'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_replication_policies') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::ReplicationPolicySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_replication_sources(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_replication_sources API.
List the replication sources of a destination bucket.
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2551 def list_replication_sources(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_replication_sources.' if logger raise "Missing the required parameter 'namespace_name' when calling list_replication_sources." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_replication_sources." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/replicationSources'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_replication_sources') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::ReplicationSource>' ) end # rubocop:enable Metrics/BlockLength end |
#list_retention_rules(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_retention_rules API.
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.
2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2616 def list_retention_rules(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_retention_rules.' if logger raise "Missing the required parameter 'namespace_name' when calling list_retention_rules." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling list_retention_rules." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/retentionRules'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_retention_rules') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::RetentionRuleCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Lists the errors of the work request with the given ID.
2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2679 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_work_request_errors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::WorkRequestError>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Lists the logs of the work request with the given ID.
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2742 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_work_request_logs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::WorkRequestLogEntry>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists the work requests in a compartment.
2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2806 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation ObjectStorageClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#list_work_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::ObjectStorage::Models::WorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
96 97 98 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 96 def logger @api_client.config.logger end |
#make_bucket_writable(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use make_bucket_writable API.
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.
2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2869 def make_bucket_writable(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#make_bucket_writable.' if logger raise "Missing the required parameter 'namespace_name' when calling make_bucket_writable." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling make_bucket_writable." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/actions/makeBucketWritable'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#make_bucket_writable') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) ⇒ Response
Click here to see an example of how to use put_object API.
Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by PutObject is 50 GiB.
See Object Names for object naming requirements.
See Special Instructions for Object Storage PUT for request signature requirements.
3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3003 def put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) logger.debug 'Calling operation ObjectStorageClient#put_object.' if logger raise "Missing the required parameter 'namespace_name' when calling put_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling put_object." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling put_object." if object_name.nil? raise "Missing the required parameter 'put_object_body' when calling put_object." if put_object_body.nil? if opts[:storage_tier] && !OCI::ObjectStorage::Models::STORAGE_TIER_ENUM.include?(opts[:storage_tier]) raise 'Invalid value for "storage_tier", must be one of the values in OCI::ObjectStorage::Models::STORAGE_TIER_ENUM.' end raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/o/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :exclude_body # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:expect] = opts[:expect] if opts[:expect] header_params[:'content-length'] = opts[:content_length] if opts[:content_length] header_params[:'content-md5'] = opts[:content_md5] if opts[:content_md5] header_params[:'content-type'] = opts[:content_type] if opts[:content_type] header_params[:'content-language'] = opts[:content_language] if opts[:content_language] header_params[:'content-encoding'] = opts[:content_encoding] if opts[:content_encoding] header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition] header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control] header_params[:'opc-sse-customer-algorithm'] = opts[:opc_sse_customer_algorithm] if opts[:opc_sse_customer_algorithm] header_params[:'opc-sse-customer-key'] = opts[:opc_sse_customer_key] if opts[:opc_sse_customer_key] header_params[:'opc-sse-customer-key-sha256'] = opts[:opc_sse_customer_key_sha256] if opts[:opc_sse_customer_key_sha256] header_params[:'opc-sse-kms-key-id'] = opts[:opc_sse_kms_key_id] if opts[:opc_sse_kms_key_id] header_params[:'storage-tier'] = opts[:storage_tier] if opts[:storage_tier] # rubocop:enable Style/NegatedIf if opts[:opc_meta] opts[:opc_meta].each do |key, value| header_params["opc-meta-#{key}".to_sym] = value end end header_params[:'content-type'] ||= 'application/octet-stream' header_params[:expect] ||= '100-continue' post_body = @api_client.object_to_http_body(put_object_body) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#put_object') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#put_object_lifecycle_policy(namespace_name, bucket_name, put_object_lifecycle_policy_details, opts = {}) ⇒ Response
Click here to see an example of how to use put_object_lifecycle_policy API.
Creates or replaces the object lifecycle policy for the bucket.
3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3099 def put_object_lifecycle_policy(namespace_name, bucket_name, put_object_lifecycle_policy_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#put_object_lifecycle_policy.' if logger raise "Missing the required parameter 'namespace_name' when calling put_object_lifecycle_policy." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling put_object_lifecycle_policy." if bucket_name.nil? raise "Missing the required parameter 'put_object_lifecycle_policy_details' when calling put_object_lifecycle_policy." if put_object_lifecycle_policy_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/l'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(put_object_lifecycle_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#put_object_lifecycle_policy') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::ObjectLifecyclePolicy' ) end # rubocop:enable Metrics/BlockLength end |
#reencrypt_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Click here to see an example of how to use reencrypt_bucket API.
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.
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.
3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3176 def reencrypt_bucket(namespace_name, bucket_name, opts = {}) logger.debug 'Calling operation ObjectStorageClient#reencrypt_bucket.' if logger raise "Missing the required parameter 'namespace_name' when calling reencrypt_bucket." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling reencrypt_bucket." if bucket_name.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/actions/reencrypt'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#reencrypt_bucket') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#reencrypt_object(namespace_name, bucket_name, object_name, reencrypt_object_details, opts = {}) ⇒ Response
Click here to see an example of how to use reencrypt_object API.
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.
You can alternatively employ one of these encryption strategies for an object:
-
You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service.
-
You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).
3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3248 def reencrypt_object(namespace_name, bucket_name, object_name, reencrypt_object_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#reencrypt_object.' if logger raise "Missing the required parameter 'namespace_name' when calling reencrypt_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling reencrypt_object." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling reencrypt_object." if object_name.nil? raise "Missing the required parameter 'reencrypt_object_details' when calling reencrypt_object." if reencrypt_object_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/actions/reencrypt/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:versionId] = opts[:version_id] if opts[:version_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(reencrypt_object_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#reencrypt_object') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#rename_object(namespace_name, bucket_name, rename_object_details, opts = {}) ⇒ Response
Click here to see an example of how to use rename_object API.
Rename an object in the given Object Storage namespace.
See Object Names for object naming requirements.
3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3315 def rename_object(namespace_name, bucket_name, rename_object_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#rename_object.' if logger raise "Missing the required parameter 'namespace_name' when calling rename_object." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling rename_object." if bucket_name.nil? raise "Missing the required parameter 'rename_object_details' when calling rename_object." if rename_object_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/actions/renameObject'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(rename_object_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#rename_object') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#restore_objects(namespace_name, bucket_name, restore_objects_details, opts = {}) ⇒ Response
Click here to see an example of how to use restore_objects API.
Restores one or more objects specified by the objectName parameter. By default objects will be restored for 24 hours. Duration can be configured using the hours parameter.
3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3377 def restore_objects(namespace_name, bucket_name, restore_objects_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#restore_objects.' if logger raise "Missing the required parameter 'namespace_name' when calling restore_objects." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling restore_objects." if bucket_name.nil? raise "Missing the required parameter 'restore_objects_details' when calling restore_objects." if restore_objects_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/actions/restoreObjects'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(restore_objects_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#restore_objects') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_bucket(namespace_name, bucket_name, update_bucket_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_bucket API.
Performs a partial or full update of a bucket's user-defined metadata.
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.
3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3446 def update_bucket(namespace_name, bucket_name, update_bucket_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#update_bucket.' if logger raise "Missing the required parameter 'namespace_name' when calling update_bucket." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling update_bucket." if bucket_name.nil? raise "Missing the required parameter 'update_bucket_details' when calling update_bucket." if update_bucket_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_bucket_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#update_bucket') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::Bucket' ) end # rubocop:enable Metrics/BlockLength end |
#update_namespace_metadata(namespace_name, update_namespace_metadata_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_namespace_metadata API.
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.
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.
3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3512 def (namespace_name, , opts = {}) logger.debug 'Calling operation ObjectStorageClient#update_namespace_metadata.' if logger raise "Missing the required parameter 'namespace_name' when calling update_namespace_metadata." if namespace_name.nil? raise "Missing the required parameter 'update_namespace_metadata_details' when calling update_namespace_metadata." if .nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) path = '/n/{namespaceName}'.sub('{namespaceName}', namespace_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#update_namespace_metadata') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::NamespaceMetadata' ) end # rubocop:enable Metrics/BlockLength end |
#update_object_storage_tier(namespace_name, bucket_name, update_object_storage_tier_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_object_storage_tier API.
Changes the storage tier of the object specified by the objectName parameter.
3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3572 def update_object_storage_tier(namespace_name, bucket_name, update_object_storage_tier_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#update_object_storage_tier.' if logger raise "Missing the required parameter 'namespace_name' when calling update_object_storage_tier." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling update_object_storage_tier." if bucket_name.nil? raise "Missing the required parameter 'update_object_storage_tier_details' when calling update_object_storage_tier." if update_object_storage_tier_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) path = '/n/{namespaceName}/b/{bucketName}/actions/updateObjectStorageTier'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_object_storage_tier_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#update_object_storage_tier') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_retention_rule(namespace_name, bucket_name, retention_rule_id, update_retention_rule_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_retention_rule API.
Updates the specified retention rule. Rule changes take effect typically within 30 seconds.
3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3638 def update_retention_rule(namespace_name, bucket_name, retention_rule_id, update_retention_rule_details, opts = {}) logger.debug 'Calling operation ObjectStorageClient#update_retention_rule.' if logger raise "Missing the required parameter 'namespace_name' when calling update_retention_rule." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling update_retention_rule." if bucket_name.nil? raise "Missing the required parameter 'retention_rule_id' when calling update_retention_rule." if retention_rule_id.nil? raise "Missing the required parameter 'update_retention_rule_details' when calling update_retention_rule." if update_retention_rule_details.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'retention_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(retention_rule_id) path = '/n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{retentionRuleId}', retention_rule_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_retention_rule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#update_retention_rule') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ObjectStorage::Models::RetentionRule' ) end # rubocop:enable Metrics/BlockLength end |
#upload_part(namespace_name, bucket_name, object_name, upload_id, upload_part_num, upload_part_body, opts = {}) ⇒ Response
Click here to see an example of how to use upload_part API.
Uploads a single part of a multipart upload.
3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3741 def upload_part(namespace_name, bucket_name, object_name, upload_id, upload_part_num, upload_part_body, opts = {}) logger.debug 'Calling operation ObjectStorageClient#upload_part.' if logger raise "Missing the required parameter 'namespace_name' when calling upload_part." if namespace_name.nil? raise "Missing the required parameter 'bucket_name' when calling upload_part." if bucket_name.nil? raise "Missing the required parameter 'object_name' when calling upload_part." if object_name.nil? raise "Missing the required parameter 'upload_id' when calling upload_part." if upload_id.nil? raise "Missing the required parameter 'upload_part_num' when calling upload_part." if upload_part_num.nil? raise "Missing the required parameter 'upload_part_body' when calling upload_part." if upload_part_body.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name) raise "Parameter value for 'object_name' must not be blank" if OCI::Internal::Util.blank_string?(object_name) path = '/n/{namespaceName}/b/{bucketName}/u/{objectName}'.sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s).sub('{objectName}', object_name.to_s) operation_signing_strategy = :exclude_body # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:uploadId] = upload_id query_params[:uploadPartNum] = upload_part_num # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:expect] = opts[:expect] if opts[:expect] header_params[:'content-length'] = opts[:content_length] if opts[:content_length] header_params[:'content-md5'] = opts[:content_md5] if opts[:content_md5] header_params[:'opc-sse-customer-algorithm'] = opts[:opc_sse_customer_algorithm] if opts[:opc_sse_customer_algorithm] header_params[:'opc-sse-customer-key'] = opts[:opc_sse_customer_key] if opts[:opc_sse_customer_key] header_params[:'opc-sse-customer-key-sha256'] = opts[:opc_sse_customer_key_sha256] if opts[:opc_sse_customer_key_sha256] header_params[:'opc-sse-kms-key-id'] = opts[:opc_sse_kms_key_id] if opts[:opc_sse_kms_key_id] # rubocop:enable Style/NegatedIf header_params[:'content-type'] ||= 'application/octet-stream' header_params[:expect] ||= '100-continue' post_body = @api_client.object_to_http_body(upload_part_body) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ObjectStorageClient#upload_part') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |