Class: OCI::ObjectStorage::ObjectStorageClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/object_storage_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil) ⇒ ObjectStorageClient

Creates a new ObjectStorageClient. If a config is not specified, then the global OCI.config will be used.

A region must be specified in either the config or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 32

def initialize(config:nil, region:nil)
  config ||= OCI.config
  config.validate

  signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::OBJECT_STORAGE)
  @api_client = ApiClient.new(config, signer)

  region ||= config.region
  self.region = region
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



12
13
14
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 12

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 16

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 20

def region
  @region
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.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • upload_id (String) —

    The upload ID for a multipart upload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 74

def abort_multipart_upload(namespace_name, bucket_name, object_name, upload_id, opts = {})
  logger.debug "Calling operation ObjectStorageClient#abort_multipart_upload." if logger

  fail "Missing the required parameter 'namespace_name' when calling abort_multipart_upload." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling abort_multipart_upload." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling abort_multipart_upload." if object_name.nil?
  fail "Missing the required parameter 'upload_id' when calling abort_multipart_upload." if upload_id.nil?

  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)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :DELETE,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
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 ETags of the parts, to create an aggregate object.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • upload_id (String) —

    The upload ID for a multipart upload.

  • commit_multipart_upload_details (CommitMultipartUploadDetails) —

    The part numbers and ETags for the parts you want to commit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 125

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

  fail "Missing the required parameter 'namespace_name' when calling commit_multipart_upload." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling commit_multipart_upload." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling commit_multipart_upload." if object_name.nil?
  fail "Missing the required parameter 'upload_id' when calling commit_multipart_upload." if upload_id.nil?
  fail "Missing the required parameter 'commit_multipart_upload_details' when calling commit_multipart_upload." if commit_multipart_upload_details.nil?

  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)

  # 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']

  post_body = @api_client.object_to_http_body(commit_multipart_upload_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
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.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • create_bucket_details (CreateBucketDetails) —

    Request object for creating a bucket.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::Bucket



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 166

def create_bucket(namespace_name, create_bucket_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#create_bucket." if logger

  fail "Missing the required parameter 'namespace_name' when calling create_bucket." if namespace_name.nil?
  fail "Missing the required parameter 'create_bucket_details' when calling create_bucket." if create_bucket_details.nil?

  path = "/n/{namespaceName}/b/".sub('{namespaceName}', namespace_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(create_bucket_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::Bucket')
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.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • create_multipart_upload_details (CreateMultipartUploadDetails) —

    Request object for creating a multi-part upload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::MultipartUpload



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 211

def create_multipart_upload(namespace_name, bucket_name, create_multipart_upload_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#create_multipart_upload." if logger

  fail "Missing the required parameter 'namespace_name' when calling create_multipart_upload." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling create_multipart_upload." if bucket_name.nil?
  fail "Missing the required parameter 'create_multipart_upload_details' when calling create_multipart_upload." if create_multipart_upload_details.nil?

  path = "/n/{namespaceName}/b/{bucketName}/u".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(create_multipart_upload_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::MultipartUpload')
end

#create_preauthenticated_request(namespace_name, bucket_name, create_preauthenticated_request_details, opts = {}) ⇒ Response

Creates a pre-authenticated request specific to the bucket.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • create_preauthenticated_request_details (CreatePreauthenticatedRequestDetails) —

    Information needed to create the pre-authenticated request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::PreauthenticatedRequest



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
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 253

def create_preauthenticated_request(namespace_name, bucket_name, create_preauthenticated_request_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#create_preauthenticated_request." if logger

  fail "Missing the required parameter 'namespace_name' when calling create_preauthenticated_request." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling create_preauthenticated_request." if bucket_name.nil?
  fail "Missing the required parameter 'create_preauthenticated_request_details' when calling create_preauthenticated_request." if create_preauthenticated_request_details.nil?

  path = "/n/{namespaceName}/b/{bucketName}/p/".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(create_preauthenticated_request_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::PreauthenticatedRequest')
end

#delete_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response

Deletes a bucket if it is already empty. If the bucket is not empty, use delete_object first.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 295

def delete_bucket(namespace_name, bucket_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#delete_bucket." if logger

  fail "Missing the required parameter 'namespace_name' when calling delete_bucket." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling delete_bucket." if bucket_name.nil?

  path = "/n/{namespaceName}/b/{bucketName}/".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :DELETE,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#delete_object(namespace_name, bucket_name, object_name, opts = {}) ⇒ Response

Deletes an object.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 339

def delete_object(namespace_name, bucket_name, object_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#delete_object." if logger

  fail "Missing the required parameter 'namespace_name' when calling delete_object." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling delete_object." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling delete_object." if object_name.nil?

  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)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :DELETE,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#delete_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) ⇒ Response

Deletes the pre-authenticated request for the bucket.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • par_id (String) —

    The unique identifier for the pre-authenticated request. This can be used to manage operations against the pre-authenticated request, such as GET or DELETE.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 380

def delete_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {})
  logger.debug "Calling operation ObjectStorageClient#delete_preauthenticated_request." if logger

  fail "Missing the required parameter 'namespace_name' when calling delete_preauthenticated_request." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling delete_preauthenticated_request." if bucket_name.nil?
  fail "Missing the required parameter 'par_id' when calling delete_preauthenticated_request." if par_id.nil?

  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)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :DELETE,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#get_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response

Gets the current representation of the given bucket in the given namespace.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::Bucket



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 424

def get_bucket(namespace_name, bucket_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#get_bucket." if logger

  fail "Missing the required parameter 'namespace_name' when calling get_bucket." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling get_bucket." if bucket_name.nil?

  path = "/n/{namespaceName}/b/{bucketName}/".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::Bucket')
end

#get_namespace(opts = {}) ⇒ Response

Gets the name of the namespace for the user making the request. An account name must be unique, must start with a letter, and can have up to 15 lowercase letters and numbers. You cannot use spaces or special characters.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type String



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 461

def get_namespace(opts = {})
  logger.debug "Calling operation ObjectStorageClient#get_namespace." if logger


  path = "/n/"

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'String')
end

#get_namespace_metadata(namespace_name, opts = {}) ⇒ Response

Get the metadata for the namespace, which contains defaultS3CompartmentId and defaultSwiftCompartmentId. Any user with the NAMESPACE_READ permission will be able to see the current metadata. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::NamespaceMetadata



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 497

def get_namespace_metadata(namespace_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#get_namespace_metadata." if logger

  fail "Missing the required parameter 'namespace_name' when calling get_namespace_metadata." if namespace_name.nil?

  path = "/n/{namespaceName}".sub('{namespaceName}', namespace_name.to_s)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::NamespaceMetadata')
end

#get_object(namespace_name, bucket_name, object_name, opts = {}, &block) ⇒ Response

Gets the metadata and body of an object.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

  • :range (String) —

    Optional byte range to fetch, as described in [RFC 7233](tools.ietf.org/rfc/rfc7233), section 2.1. Note that only a single range of bytes is supported.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 548

def get_object(namespace_name, bucket_name, object_name, opts = {}, &block)
  logger.debug "Calling operation ObjectStorageClient#get_object." if logger

  fail "Missing the required parameter 'namespace_name' when calling get_object." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling get_object." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling get_object." if object_name.nil?

  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)

  # 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[:'range'] = opts[:'range'] if opts[:'range']

  post_body = nil

  if !block.nil?
    return @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      body: post_body,
      return_type: 'Stream',
      &block
    )
  elsif opts[:response_target]
    if opts[:response_target].respond_to? :write
      return @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, response| opts[:response_target].write(chunk) }
      )
    elsif opts[:response_target].is_a?(String)
      open(opts[:response_target], 'wb') do |output|
        return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, response| output.write(chunk) }
        )
      end
    end
  else
    return @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params:header_params,
        query_params: query_params,
        body: post_body,
        return_type: 'String'
    )
  end
end

#get_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {}) ⇒ Response

Gets the pre-authenticated request for the bucket.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • par_id (String) —

    The unique identifier for the pre-authenticated request. This can be used to manage operations against the pre-authenticated request, such as GET or DELETE.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::PreauthenticatedRequestSummary



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 632

def get_preauthenticated_request(namespace_name, bucket_name, par_id, opts = {})
  logger.debug "Calling operation ObjectStorageClient#get_preauthenticated_request." if logger

  fail "Missing the required parameter 'namespace_name' when calling get_preauthenticated_request." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling get_preauthenticated_request." if bucket_name.nil?
  fail "Missing the required parameter 'par_id' when calling get_preauthenticated_request." if par_id.nil?

  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)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::PreauthenticatedRequestSummary')
end

#head_bucket(namespace_name, bucket_name, opts = {}) ⇒ Response

Efficiently checks to see if a bucket exists and gets the current ETag for the bucket.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
705
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 677

def head_bucket(namespace_name, bucket_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#head_bucket." if logger

  fail "Missing the required parameter 'namespace_name' when calling head_bucket." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling head_bucket." if bucket_name.nil?

  path = "/n/{namespaceName}/b/{bucketName}/".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :HEAD,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#head_object(namespace_name, bucket_name, object_name, opts = {}) ⇒ Response

Gets the user-defined metadata and entity tag for an object.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 725

def head_object(namespace_name, bucket_name, object_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#head_object." if logger

  fail "Missing the required parameter 'namespace_name' when calling head_object." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling head_object." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling head_object." if object_name.nil?

  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)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :HEAD,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#list_buckets(namespace_name, compartment_id, opts = {}) ⇒ Response

Gets a list of all ‘BucketSummary`s 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’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • compartment_id (String) —

    The ID of the compartment in which to create the bucket.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page at which to start retrieving results.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Array<OCI::ObjectStorage::Models::BucketSummary>



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 770

def list_buckets(namespace_name, compartment_id, opts = {})
  logger.debug "Calling operation ObjectStorageClient#list_buckets." if logger

  fail "Missing the required parameter 'namespace_name' when calling list_buckets." if namespace_name.nil?
  fail "Missing the required parameter 'compartment_id' when calling list_buckets." if compartment_id.nil?

  path = "/n/{namespaceName}/b/".sub('{namespaceName}', namespace_name.to_s)

  # 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']

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'Array<OCI::ObjectStorage::Models::BucketSummary>')
end

#list_multipart_upload_parts(namespace_name, bucket_name, object_name, upload_id, opts = {}) ⇒ Response

Lists the parts of an in-progress multipart upload.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • upload_id (String) —

    The upload ID for a multipart upload.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page at which to start retrieving results.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Array<OCI::ObjectStorage::Models::MultipartUploadPartSummary>



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 817

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

  fail "Missing the required parameter 'namespace_name' when calling list_multipart_upload_parts." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling list_multipart_upload_parts." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling list_multipart_upload_parts." if object_name.nil?
  fail "Missing the required parameter 'upload_id' when calling list_multipart_upload_parts." if upload_id.nil?

  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)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'Array<OCI::ObjectStorage::Models::MultipartUploadPartSummary>')
end

#list_multipart_uploads(namespace_name, bucket_name, opts = {}) ⇒ Response

Lists all in-progress multipart uploads for the given bucket in the given namespace.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page at which to start retrieving results.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Array<OCI::ObjectStorage::Models::MultipartUpload>



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
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 862

def list_multipart_uploads(namespace_name, bucket_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#list_multipart_uploads." if logger

  fail "Missing the required parameter 'namespace_name' when calling list_multipart_uploads." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling list_multipart_uploads." if bucket_name.nil?

  path = "/n/{namespaceName}/b/{bucketName}/u".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'Array<OCI::ObjectStorage::Models::MultipartUpload>')
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’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :prefix (String) —

    The string to use for matching against the start of object names in a list query.

  • :start (String) —

    Object names returned by a list query must be greater or equal to this parameter.

  • :_end (String) —

    Object names returned by a list query must be strictly less than this parameter.

  • :limit (Integer) —

    The maximum number of items to return.

  • :delimiter (String) —

    When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned. Scanned objects whose names contain the delimiter have part of their name up to the last occurrence of the delimiter (after the optional prefix) returned as a set of prefixes. Note that only ‘/’ is a supported delimiter character at this time.

  • :fields (String) —

    Object summary in list of objects includes the ‘name’ field. This parameter can also include ‘size’ (object size in bytes), ‘md5’, and ‘timeCreated’ (object creation date and time) fields. Value of this parameter should be a comma-separated, case-insensitive list of those field names. For example ‘name,timeCreated,md5’.

    Allowed values are: name, size, timeCreated, md5

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::ListObjects



922
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
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 922

def list_objects(namespace_name, bucket_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#list_objects." if logger

  fail "Missing the required parameter 'namespace_name' when calling list_objects." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling list_objects." if bucket_name.nil?

  if opts[:'fields'] && !['name', 'size', 'timeCreated', 'md5'].include?(opts[:'fields'])
    fail 'Invalid value for "fields", must be one of name, size, timeCreated, md5.'
  end

  path = "/n/{namespaceName}/b/{bucketName}/o".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # Query Params
  query_params = {}
  query_params[:'prefix'] = opts[:'prefix'] if opts[:'prefix']
  query_params[:'start'] = opts[:'start'] if opts[:'start']
  query_params[:'end'] = opts[:'_end'] if opts[:'_end']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'delimiter'] = opts[:'delimiter'] if opts[:'delimiter']
  query_params[:'fields'] = opts[:'fields'] if opts[:'fields']

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'
  header_params[:'opc-client-request-id'] = opts[:'opc_client_request_id'] if opts[:'opc_client_request_id']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::ListObjects')
end

#list_preauthenticated_requests(namespace_name, bucket_name, opts = {}) ⇒ Response

Lists pre-authenticated requests for the bucket.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :object_name_prefix (String) —

    User-specified object name prefixes can be used to query and return a list of pre-authenticated requests.

  • :limit (Integer) —

    The maximum number of items to return.

  • :page (String) —

    The page at which to start retrieving results.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type Array<OCI::ObjectStorage::Models::PreauthenticatedRequestSummary>



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 973

def list_preauthenticated_requests(namespace_name, bucket_name, opts = {})
  logger.debug "Calling operation ObjectStorageClient#list_preauthenticated_requests." if logger

  fail "Missing the required parameter 'namespace_name' when calling list_preauthenticated_requests." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling list_preauthenticated_requests." if bucket_name.nil?

  path = "/n/{namespaceName}/b/{bucketName}/p/".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'Array<OCI::ObjectStorage::Models::PreauthenticatedRequestSummary>')
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



56
57
58
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 56

def logger
  @api_client.config.logger
end

#put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {}) ⇒ Response

Creates a new object or overwrites an existing one.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • put_object_body (String, IO) —

    The object to upload to the object store.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content_length (Integer) —

    The content length of the body.

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

  • :expect (String) —

    100-continue (default to 100-continue)

  • :content_md5 (String) —

    The base-64 encoded MD5 hash of the body.

  • :content_type (String) —

    The content type of the object. Defaults to ‘application/octet-stream’ if not overridden during the PutObject call.

  • :content_language (String) —

    The content language of the object.

  • :content_encoding (String) —

    The content encoding of the object.

  • :opc_meta (dict(str, str)) —

    Optional user-defined metadata key and value.

Returns:

  • (Response) —

    A Response object with data of type nil



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 1031

def put_object(namespace_name, bucket_name, object_name, put_object_body, opts = {})
  logger.debug "Calling operation ObjectStorageClient#put_object." if logger

  fail "Missing the required parameter 'namespace_name' when calling put_object." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling put_object." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling put_object." if object_name.nil?
  fail "Missing the required parameter 'put_object_body' when calling put_object." if put_object_body.nil?

  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)

  # 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']

  if opts[:opc_meta]
    opts[:opc_meta].each do |key, value|
      header_params["opc-meta-#{key}".to_sym] = value
    end
  end

  post_body = @api_client.object_to_http_body(put_object_body)

  return @api_client.call_api(
    :PUT,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#rename_object(namespace_name, bucket_name, rename_object_details, opts = {}) ⇒ Response

Rename an object from source key to target key in the given namespace.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • rename_object_details (RenameObjectDetails) —

    The sourceName and newName of rename operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 1084

def rename_object(namespace_name, bucket_name, rename_object_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#rename_object." if logger

  fail "Missing the required parameter 'namespace_name' when calling rename_object." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling rename_object." if bucket_name.nil?
  fail "Missing the required parameter 'rename_object_details' when calling rename_object." if rename_object_details.nil?

  path = "/n/{namespaceName}/b/{bucketName}/actions/renameObject".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(rename_object_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#restore_objects(namespace_name, bucket_name, restore_objects_details, opts = {}) ⇒ Response

Restore one or more objects specified by objectName parameter.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • restore_objects_details (RestoreObjectsDetails) —

    Request to restore objects.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 1123

def restore_objects(namespace_name, bucket_name, restore_objects_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#restore_objects." if logger

  fail "Missing the required parameter 'namespace_name' when calling restore_objects." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling restore_objects." if bucket_name.nil?
  fail "Missing the required parameter 'restore_objects_details' when calling restore_objects." if restore_objects_details.nil?

  path = "/n/{namespaceName}/b/{bucketName}/actions/restoreObjects".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(restore_objects_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
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.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • update_bucket_details (UpdateBucketDetails) —

    Request object for updating a bucket.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::Bucket



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 1165

def update_bucket(namespace_name, bucket_name, update_bucket_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#update_bucket." if logger

  fail "Missing the required parameter 'namespace_name' when calling update_bucket." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling update_bucket." if bucket_name.nil?
  fail "Missing the required parameter 'update_bucket_details' when calling update_bucket." if update_bucket_details.nil?

  path = "/n/{namespaceName}/b/{bucketName}/".sub('{namespaceName}', namespace_name.to_s).sub('{bucketName}', bucket_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(update_bucket_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::Bucket')
end

#update_namespace_metadata(namespace_name, update_namespace_metadata_details, opts = {}) ⇒ Response

Change the default Swift/S3 compartmentId of user’s namespace into the user-defined compartmentId. Upon doing this, all subsequent bucket creations will use the new default compartment, but no previously created buckets will be modified. A user must have the NAMESPACE_UPDATE permission to make changes to the default compartments for S3 and Swift.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • update_namespace_metadata_details (UpdateNamespaceMetadataDetails) —

    Request object for update NamespaceMetadata.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type OCI::ObjectStorage::Models::NamespaceMetadata



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
1233
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 1206

def update_namespace_metadata(namespace_name, update_namespace_metadata_details, opts = {})
  logger.debug "Calling operation ObjectStorageClient#update_namespace_metadata." if logger

  fail "Missing the required parameter 'namespace_name' when calling update_namespace_metadata." if namespace_name.nil?
  fail "Missing the required parameter 'update_namespace_metadata_details' when calling update_namespace_metadata." if update_namespace_metadata_details.nil?

  path = "/n/{namespaceName}".sub('{namespaceName}', namespace_name.to_s)

  # 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']

  post_body = @api_client.object_to_http_body(update_namespace_metadata_details)

  return @api_client.call_api(
    :PUT,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::ObjectStorage::Models::NamespaceMetadata')
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.

Parameters:

  • namespace_name (String) —

    The top-level namespace used for the request.

  • bucket_name (String) —

    The name of the bucket. Avoid entering confidential information. Example: ‘my-new-bucket1`

  • object_name (String) —

    The name of the object. Avoid entering confidential information. Example: ‘test/object1.log`

  • upload_id (String) —

    The upload ID for a multipart upload.

  • upload_part_num (Integer) —

    The part number that identifies the object part currently being uploaded.

  • upload_part_body (String, IO) —

    The part being uploaded to the Object Storage Service.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content_length (Integer) —

    The content length of the body.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    The entity tag to match. For creating and committing a multipart upload to an object, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :if_none_match (String) —

    The entity tag to avoid matching. The only valid value is u2018*u2019, which indicates that the request should fail if the object already exists. For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.

  • :expect (String) —

    100-continue (default to 100-continue)

  • :content_md5 (String) —

    The base-64 encoded MD5 hash of the body.

Returns:

  • (Response) —

    A Response object with data of type nil



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
1293
1294
1295
 
# File 'lib/oci/object_storage/object_storage_client.rb', line 1259

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

  fail "Missing the required parameter 'namespace_name' when calling upload_part." if namespace_name.nil?
  fail "Missing the required parameter 'bucket_name' when calling upload_part." if bucket_name.nil?
  fail "Missing the required parameter 'object_name' when calling upload_part." if object_name.nil?
  fail "Missing the required parameter 'upload_id' when calling upload_part." if upload_id.nil?
  fail "Missing the required parameter 'upload_part_num' when calling upload_part." if upload_part_num.nil?
  fail "Missing the required parameter 'upload_part_body' when calling upload_part." if upload_part_body.nil?

  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)

  # 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']

  post_body = @api_client.object_to_http_body(upload_part_body)

  return @api_client.call_api(
    :PUT,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end