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. For more information, see [Overview of Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) and [Overview of Archive Storage](/Content/Archive/Concepts/archivestorageoverview.htm).
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_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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 55 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.
15 16 17 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 29 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
25 26 27 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 25 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.
118 119 120 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 118 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.
177 178 179 180 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 177 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.
245 246 247 248 249 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 245 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.
335 336 337 338 339 340 341 342 343 344 345 346 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 335 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] # 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.
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 399 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.
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 476 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] # 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.
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 542 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
Creates a replication policy for the specified bucket.
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 603 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
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.
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 665 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
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.
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 731 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.
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 797 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
Deletes the object lifecycle policy for the bucket.
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 862 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.
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 923 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
Deletes the replication policy associated with the source bucket.
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 984 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
Deletes the specified rule. The deletion takes effect typically within 30 seconds.
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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1047 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
Gets the current representation of the given bucket in the given Object Storage namespace.
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1120 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.
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1197 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 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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1256 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.
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 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1346 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
Gets the object lifecycle policy for the bucket.
1464 1465 1466 1467 1468 1469 1470 1471 1472 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1464 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.
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1525 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
Get the replication policy.
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1587 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
Get the specified retention rule.
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 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1648 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
Gets the status of the work request for the given ID.
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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1705 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.
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 1808 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1769 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.
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1851 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
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).
1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 1927 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.
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 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2005 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.
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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2072 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
Lists the object versions 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).
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 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2156 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].include?(opts[:fields]) raise 'Invalid value for "fields", must be one of name, size, etag, timeCreated, md5, timeModified.' 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
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).
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 2287 2288 2289 2290 2291 2292 2293 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2248 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
Lists pre-authenticated requests for the bucket.
2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2317 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
List the replication policies associated with a bucket.
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2381 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
List the replication sources of a destination bucket.
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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2444 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
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.
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2506 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
Lists the errors of the work request with the given ID.
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 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2563 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.
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 2655 2656 2657 2658 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2620 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.
2678 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2678 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.
94 95 96 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 94 def logger @api_client.config.logger end |
#make_bucket_writable(namespace_name, bucket_name, opts = {}) ⇒ Response
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.
2740 2741 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2740 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
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](docs.cloud.oracle.com/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.
See [Special Instructions for Object Storage PUT](docs.cloud.oracle.com/Content/API/Concepts/signingrequests.htm#ObjectStoragePut) for request signature requirements.
2864 2865 2866 2867 2868 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 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2864 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] 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] # 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.
2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 2952 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
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.
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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3028 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
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).
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 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
Rename an object in the given Object Storage namespace.
See [Object Names](docs.cloud.oracle.com/Content/Object/Tasks/managingobjects.htm#namerequirements) for object naming requirements.
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 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 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3165 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.
3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3226 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.
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](docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3293 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 OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default compartments for Amazon S3 and Swift.
3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3358 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_retention_rule(namespace_name, bucket_name, retention_rule_id, update_retention_rule_details, opts = {}) ⇒ Response
Updates the specified retention rule. Rule changes take effect typically within 30 seconds.
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3421 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
Uploads a single part of a multipart upload.
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 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 |
# File 'lib/oci/object_storage/object_storage_client.rb', line 3517 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] # 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 |