Class: OCI::ObjectStorage::ObjectStorageClient
- Inherits:
-
Object
- Object
- OCI::ObjectStorage::ObjectStorageClient
- Defined in:
- lib/oci/object_storage/object_storage_client.rb
Overview
Common set of Object Storage and Archive Storage APIs for managing buckets, objects, and related resources.
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.
-
#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.
-
#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_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_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_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.
-
#put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) ⇒ Response
Creates a new object or overwrites an existing one.
-
#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.
-
#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.
-
#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.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 52 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @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.
12 13 14 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 12 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
16 17 18 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 16 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
26 27 28 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 26 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
22 23 24 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 22 def retry_config @retry_config end |
Instance Method Details
#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.
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 163 164 165 166 167 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 126 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
Cancels a work request.
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 217 218 219 220 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 185 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
Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.
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 295 296 297 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 253 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
Creates a request to copy an object within a region or to another region.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 319 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] # 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
Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering confidential information in bucket names.
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 377 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
Starts a new multipart upload to a specific object in the given bucket in the given namespace.
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 443 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] # 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
Creates a pre-authenticated request specific to the bucket.
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 543 544 545 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 506 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 |
#delete_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Deletes a bucket if the bucket is already empty. If the bucket is not empty, use delete_object first. You also cannot delete a bucket that has a pre-authenticated request associated with that bucket.
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 605 606 607 608 609 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 571 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
Deletes an object.
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 667 668 669 670 671 672 673 674 675 676 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 636 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 = {} # 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
Deletes the object lifecycle policy for the bucket.
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 730 731 732 733 734 735 736 737 738 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 700 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
Deletes the pre-authenticated request for the bucket.
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 797 798 799 800 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 761 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 |
#get_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response
Gets the current representation of the given bucket in the given Object Storage namespace.
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 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 833 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] 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.' 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
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.
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 910 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
Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId.
Any user with the 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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
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 995 996 997 998 999 1000 1001 1002 1003 1004 1005 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 969 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
Gets the metadata and body of an object.
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 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 1123 1124 1125 1126 1127 1128 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1041 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 = {} # 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] # 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
Gets the object lifecycle policy for the bucket.
1149 1150 1151 1152 1153 1154 1155 1156 1157 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1149 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
Gets the pre-authenticated request for the bucket.
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1210 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_work_request(work_request_id, opts = {}) ⇒ Response
Gets the status of the work request for the given ID.
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1267 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
Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1331 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
Gets the user-defined metadata and entity tag (ETag) for an object.
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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1401 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 = {} # 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_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
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.
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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1473 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
Lists the parts of an in-progress multipart upload.
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1551 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
Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1618 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_objects(namespace_name, bucket_name, opts = {}) ⇒ Response
Lists the objects in a bucket.
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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
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 1735 1736 1737 1738 1739 1740 1741 1742 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1698 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] # 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
Lists pre-authenticated requests for the bucket.
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1766 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_work_request_errors(work_request_id, opts = {}) ⇒ Response
Lists the errors of the work request with the given ID.
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 1858 1859 1860 1861 1862 1863 1864 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1826 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
Lists the logs of the work request with the given ID.
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1883 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
Lists the work requests in a compartment.
1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1941 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.
102 103 104 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 102 def logger @api_client.config.logger end |
#put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) ⇒ Response
Creates a new object or overwrites an existing one. See [Special Instructions for Object Storage PUT](docs.cloud.oracle.com/Content/API/Concepts/signingrequests.htm#ObjectStoragePut) for request signature requirements.
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2025 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? 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] # 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' 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
Creates or replaces the object lifecycle policy for the bucket.
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2108 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 |
#rename_object(namespace_name, bucket_name, rename_object_details, opts = {}) ⇒ Response
Rename an object in the given Object Storage namespace.
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2171 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
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.
2232 2233 2234 2235 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2232 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
Performs a partial or full update of a bucket’s user-defined metadata.
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2295 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
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 NAMESPACE_UPDATE permission to make changes to the default compartments for Amazon S3 and Swift.
2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2360 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 |
#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.
2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2439 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] # rubocop:enable Style/NegatedIf header_params[:'content-type'] ||= 'application/octet-stream' 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 |