Class: QingStor::SDK::Bucket

Inherits:
Object
  • Object
show all
Defined in:
lib/qingstor/sdk/service/bucket.rb,
lib/qingstor/sdk/service/object.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, properties) ⇒ Bucket

Returns a new instance of Bucket.



24
25
26
27
28
# File 'lib/qingstor/sdk/service/bucket.rb', line 24

def initialize(config, properties)
  config.check
  self.config     = config
  self.properties = properties.deep_symbolize_keys
end

Instance Attribute Details

#configObject

Returns the value of attribute config.



22
23
24
# File 'lib/qingstor/sdk/service/bucket.rb', line 22

def config
  @config
end

#propertiesObject

Returns the value of attribute properties.



22
23
24
# File 'lib/qingstor/sdk/service/bucket.rb', line 22

def properties
  @properties
end

Instance Method Details

#abort_multipart_upload(object_key, upload_id: '') ⇒ Object

abort_multipart_upload: Abort multipart upload. Documentation URL: docs.qingcloud.com/qingstor/api/object/abort_multipart_upload.html



26
27
28
29
# File 'lib/qingstor/sdk/service/object.rb', line 26

def abort_multipart_upload(object_key, upload_id: '')
  request = abort_multipart_upload_request object_key, upload_id: upload_id
  request.send
end

#abort_multipart_upload_request(object_key, upload_id: '') ⇒ Object



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/qingstor/sdk/service/object.rb', line 31

def abort_multipart_upload_request(object_key, upload_id: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Abort Multipart Upload',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
      'upload_id' => upload_id
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  abort_multipart_upload_input_validate input
  Request.new input
end

#append_object(object_key, position: nil, content_length: nil, content_md5: '', content_type: '', x_qs_storage_class: '', body: nil) ⇒ Object

append_object: Append the Object. Documentation URL: docs.qingcloud.com/qingstor/api/object/append.html



71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/qingstor/sdk/service/object.rb', line 71

def append_object(object_key, position: nil, content_length: nil,
                  content_md5: '',
                  content_type: '',
                  x_qs_storage_class: '',
                  body: nil)
  request = append_object_request object_key, position: position, content_length: content_length,
    content_md5: content_md5,
    content_type: content_type,
    x_qs_storage_class: x_qs_storage_class,
    body: body
  request.send
end

#append_object_request(object_key, position: nil, content_length: nil, content_md5: '', content_type: '', x_qs_storage_class: '', body: nil) ⇒ Object



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/qingstor/sdk/service/object.rb', line 84

def append_object_request(object_key, position: nil, content_length: nil,
                          content_md5: '',
                          content_type: '',
                          x_qs_storage_class: '',
                          body: nil)
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Append Object',
    request_method:   'POST',
    request_uri:      '/<bucket-name>/<object-key>?append',
    request_params:   {
      'position' => position
    },
    request_headers:  {
      'Content-Length'     => content_length,
      'Content-MD5'        => content_md5,
      'Content-Type'       => content_type,
      'X-QS-Storage-Class' => x_qs_storage_class
    },
    request_elements: {
    },
    request_body:     body,

    status_code:      [
      200
    ]
  }

  append_object_input_validate input
  Request.new input
end

#complete_multipart_upload(object_key, upload_id: '', etag: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', object_parts: []) ⇒ Object

complete_multipart_upload: Complete multipart upload. Documentation URL: docs.qingcloud.com/qingstor/api/object/complete_multipart_upload.html



143
144
145
146
147
148
149
150
151
152
# File 'lib/qingstor/sdk/service/object.rb', line 143

def complete_multipart_upload(object_key, upload_id: '', etag: '',
                              x_qs_encryption_customer_algorithm: '',
                              x_qs_encryption_customer_key: '',
                              x_qs_encryption_customer_key_md5: '', object_parts: [])
  request = complete_multipart_upload_request object_key, upload_id: upload_id, etag: etag,
    x_qs_encryption_customer_algorithm: x_qs_encryption_customer_algorithm,
    x_qs_encryption_customer_key: x_qs_encryption_customer_key,
    x_qs_encryption_customer_key_md5: x_qs_encryption_customer_key_md5, object_parts: object_parts
  request.send
end

#complete_multipart_upload_request(object_key, upload_id: '', etag: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', object_parts: []) ⇒ Object



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/qingstor/sdk/service/object.rb', line 154

def complete_multipart_upload_request(object_key, upload_id: '', etag: '',
                                      x_qs_encryption_customer_algorithm: '',
                                      x_qs_encryption_customer_key: '',
                                      x_qs_encryption_customer_key_md5: '', object_parts: [])
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Complete multipart upload',
    request_method:   'POST',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
      'upload_id' => upload_id
    },
    request_headers:  {
      'ETag'                               => etag,
      'X-QS-Encryption-Customer-Algorithm' => x_qs_encryption_customer_algorithm,
      'X-QS-Encryption-Customer-Key'       => x_qs_encryption_customer_key,
      'X-QS-Encryption-Customer-Key-MD5'   => x_qs_encryption_customer_key_md5
    },
    request_elements: {
      'object_parts' => object_parts
    },
    request_body:     nil,

    status_code:      [
      201
    ]
  }

  complete_multipart_upload_input_validate input
  Request.new input
end

#deleteObject

delete_bucket: Delete a bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/delete.html



32
33
34
35
# File 'lib/qingstor/sdk/service/bucket.rb', line 32

def delete
  request = delete_request
  request.send
end

#delete_cname(domain: '') ⇒ Object

delete_bucket_cname: Delete bucket CNAME setting of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/cname/delete_cname.html



71
72
73
74
# File 'lib/qingstor/sdk/service/bucket.rb', line 71

def delete_cname(domain: '')
  request = delete_cname_request domain: domain
  request.send
end

#delete_cname_request(domain: '') ⇒ Object



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/qingstor/sdk/service/bucket.rb', line 76

def delete_cname_request(domain: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket CNAME',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?cname',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'domain' => domain
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_cname_input_validate input
  Request.new input
end

#delete_corsObject

delete_bucket_cors: Delete CORS information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/cors/delete_cors.html



115
116
117
118
# File 'lib/qingstor/sdk/service/bucket.rb', line 115

def delete_cors
  request = delete_cors_request
  request.send
end

#delete_cors_requestObject



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/qingstor/sdk/service/bucket.rb', line 120

def delete_cors_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket CORS',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?cors',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_cors_input_validate input
  Request.new input
end

#delete_external_mirrorObject

delete_bucket_external_mirror: Delete external mirror of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/external_mirror/delete_external_mirror.html



154
155
156
157
# File 'lib/qingstor/sdk/service/bucket.rb', line 154

def delete_external_mirror
  request = delete_external_mirror_request
  request.send
end

#delete_external_mirror_requestObject



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/qingstor/sdk/service/bucket.rb', line 159

def delete_external_mirror_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket External Mirror',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?mirror',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_external_mirror_input_validate input
  Request.new input
end

#delete_lifecycleObject

delete_bucket_lifecycle: Delete Lifecycle information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/lifecycle/delete_lifecycle.html



193
194
195
196
# File 'lib/qingstor/sdk/service/bucket.rb', line 193

def delete_lifecycle
  request = delete_lifecycle_request
  request.send
end

#delete_lifecycle_requestObject



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/qingstor/sdk/service/bucket.rb', line 198

def delete_lifecycle_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket Lifecycle',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?lifecycle',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_lifecycle_input_validate input
  Request.new input
end

#delete_loggingObject

delete_bucket_logging: Delete bucket logging setting of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/logging/delete_logging.html



232
233
234
235
# File 'lib/qingstor/sdk/service/bucket.rb', line 232

def delete_logging
  request = delete_logging_request
  request.send
end

#delete_logging_requestObject



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/qingstor/sdk/service/bucket.rb', line 237

def delete_logging_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket Logging',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?logging',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_logging_input_validate input
  Request.new input
end

#delete_multiple_objects(objects: [], quiet: nil) ⇒ Object

delete_multiple_objects: Delete multiple objects from the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/delete_multiple.html



388
389
390
391
392
393
# File 'lib/qingstor/sdk/service/bucket.rb', line 388

def delete_multiple_objects(objects: [],
                            quiet: nil)
  request = delete_multiple_objects_request objects: objects,
                                            quiet:   quiet
  request.send
end

#delete_multiple_objects_request(objects: [], quiet: nil) ⇒ Object



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/qingstor/sdk/service/bucket.rb', line 395

def delete_multiple_objects_request(objects: [],
                                    quiet: nil)
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Delete Multiple Objects',
    request_method:   'POST',
    request_uri:      '/<bucket-name>?delete',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'objects' => objects,
      'quiet'   => quiet
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  delete_multiple_objects_input_validate input
  Request.new input
end

#delete_notificationObject

delete_bucket_notification: Delete Notification information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/notification/delete_notification.html



271
272
273
274
# File 'lib/qingstor/sdk/service/bucket.rb', line 271

def delete_notification
  request = delete_notification_request
  request.send
end

#delete_notification_requestObject



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/qingstor/sdk/service/bucket.rb', line 276

def delete_notification_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket Notification',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?notification',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_notification_input_validate input
  Request.new input
end

#delete_object(object_key) ⇒ Object

delete_object: Delete the object. Documentation URL: docs.qingcloud.com/qingstor/api/object/delete.html



212
213
214
215
# File 'lib/qingstor/sdk/service/object.rb', line 212

def delete_object(object_key)
  request = delete_object_request object_key
  request.send
end

#delete_object_request(object_key) ⇒ Object



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/qingstor/sdk/service/object.rb', line 217

def delete_object_request(object_key)
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Object',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_object_input_validate input
  Request.new input
end

#delete_policyObject

delete_bucket_policy: Delete policy information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/policy/delete_policy.html



310
311
312
313
# File 'lib/qingstor/sdk/service/bucket.rb', line 310

def delete_policy
  request = delete_policy_request
  request.send
end

#delete_policy_requestObject



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/qingstor/sdk/service/bucket.rb', line 315

def delete_policy_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket Policy',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?policy',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_policy_input_validate input
  Request.new input
end

#delete_replicationObject

delete_bucket_replication: Delete Replication information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/replication/delete_replication.html



349
350
351
352
# File 'lib/qingstor/sdk/service/bucket.rb', line 349

def delete_replication
  request = delete_replication_request
  request.send
end

#delete_replication_requestObject



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/qingstor/sdk/service/bucket.rb', line 354

def delete_replication_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket Replication',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>?replication',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_replication_input_validate input
  Request.new input
end

#delete_requestObject



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/qingstor/sdk/service/bucket.rb', line 37

def delete_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'DELETE Bucket',
    request_method:   'DELETE',
    request_uri:      '/<bucket-name>',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      204
    ]
  }

  delete_bucket_input_validate input
  Request.new input
end

#get_aclObject

get_bucket_acl: Get ACL information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/get_acl.html



439
440
441
442
# File 'lib/qingstor/sdk/service/bucket.rb', line 439

def get_acl
  request = get_acl_request
  request.send
end

#get_acl_requestObject



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
# File 'lib/qingstor/sdk/service/bucket.rb', line 444

def get_acl_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket ACL',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?acl',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_acl_input_validate input
  Request.new input
end

#get_cname(type: '') ⇒ Object

get_bucket_cname: Get bucket CNAME setting of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/cname/get_cname.html



478
479
480
481
# File 'lib/qingstor/sdk/service/bucket.rb', line 478

def get_cname(type: '')
  request = get_cname_request type: type
  request.send
end

#get_cname_request(type: '') ⇒ Object



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'lib/qingstor/sdk/service/bucket.rb', line 483

def get_cname_request(type: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket CNAME',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?cname',
    request_params:   {
      'type' => type
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_cname_input_validate input
  Request.new input
end

#get_corsObject

get_bucket_cors: Get CORS information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/cors/get_cors.html



529
530
531
532
# File 'lib/qingstor/sdk/service/bucket.rb', line 529

def get_cors
  request = get_cors_request
  request.send
end

#get_cors_requestObject



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'lib/qingstor/sdk/service/bucket.rb', line 534

def get_cors_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket CORS',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?cors',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_cors_input_validate input
  Request.new input
end

#get_external_mirrorObject

get_bucket_external_mirror: Get external mirror of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/external_mirror/get_external_mirror.html



568
569
570
571
# File 'lib/qingstor/sdk/service/bucket.rb', line 568

def get_external_mirror
  request = get_external_mirror_request
  request.send
end

#get_external_mirror_requestObject



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/qingstor/sdk/service/bucket.rb', line 573

def get_external_mirror_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket External Mirror',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?mirror',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_external_mirror_input_validate input
  Request.new input
end

#get_lifecycleObject

get_bucket_lifecycle: Get Lifecycle information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/lifecycle/get_lifecycle.html



607
608
609
610
# File 'lib/qingstor/sdk/service/bucket.rb', line 607

def get_lifecycle
  request = get_lifecycle_request
  request.send
end

#get_lifecycle_requestObject



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
# File 'lib/qingstor/sdk/service/bucket.rb', line 612

def get_lifecycle_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket Lifecycle',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?lifecycle',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_lifecycle_input_validate input
  Request.new input
end

#get_loggingObject

get_bucket_logging: Get bucket logging setting of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/logging/get_logging.html



646
647
648
649
# File 'lib/qingstor/sdk/service/bucket.rb', line 646

def get_logging
  request = get_logging_request
  request.send
end

#get_logging_requestObject



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'lib/qingstor/sdk/service/bucket.rb', line 651

def get_logging_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket Logging',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?logging',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_logging_input_validate input
  Request.new input
end

#get_notificationObject

get_bucket_notification: Get Notification information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/notification/get_notification.html



685
686
687
688
# File 'lib/qingstor/sdk/service/bucket.rb', line 685

def get_notification
  request = get_notification_request
  request.send
end

#get_notification_requestObject



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
# File 'lib/qingstor/sdk/service/bucket.rb', line 690

def get_notification_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket Notification',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?notification',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_notification_input_validate input
  Request.new input
end

#get_object(object_key, response_cache_control: '', response_content_disposition: '', response_content_encoding: '', response_content_language: '', response_content_type: '', response_expires: '', if_match: '', if_modified_since: '', if_none_match: '', if_unmodified_since: '', range: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '') ⇒ Object

get_object: Retrieve the object. Documentation URL: docs.qingcloud.com/qingstor/api/object/get.html



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
# File 'lib/qingstor/sdk/service/object.rb', line 252

def get_object(object_key, response_cache_control: '',
               response_content_disposition: '',
               response_content_encoding: '',
               response_content_language: '',
               response_content_type: '',
               response_expires: '', if_match: '',
               if_modified_since: '',
               if_none_match: '',
               if_unmodified_since: '',
               range: '',
               x_qs_encryption_customer_algorithm: '',
               x_qs_encryption_customer_key: '',
               x_qs_encryption_customer_key_md5: '')
  request = get_object_request object_key, response_cache_control: response_cache_control,
    response_content_disposition: response_content_disposition,
    response_content_encoding: response_content_encoding,
    response_content_language: response_content_language,
    response_content_type: response_content_type,
    response_expires: response_expires, if_match: if_match,
    if_modified_since: if_modified_since,
    if_none_match: if_none_match,
    if_unmodified_since: if_unmodified_since,
    range: range,
    x_qs_encryption_customer_algorithm: x_qs_encryption_customer_algorithm,
    x_qs_encryption_customer_key: x_qs_encryption_customer_key,
    x_qs_encryption_customer_key_md5: x_qs_encryption_customer_key_md5
  request.send
end

#get_object_request(object_key, response_cache_control: '', response_content_disposition: '', response_content_encoding: '', response_content_language: '', response_content_type: '', response_expires: '', if_match: '', if_modified_since: '', if_none_match: '', if_unmodified_since: '', range: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '') ⇒ Object



281
282
283
284
285
286
287
288
289
290
291
292
293
294
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
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/qingstor/sdk/service/object.rb', line 281

def get_object_request(object_key, response_cache_control: '',
                       response_content_disposition: '',
                       response_content_encoding: '',
                       response_content_language: '',
                       response_content_type: '',
                       response_expires: '', if_match: '',
                       if_modified_since: '',
                       if_none_match: '',
                       if_unmodified_since: '',
                       range: '',
                       x_qs_encryption_customer_algorithm: '',
                       x_qs_encryption_customer_key: '',
                       x_qs_encryption_customer_key_md5: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Object',
    request_method:   'GET',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
      'response-cache-control'       => response_cache_control,
      'response-content-disposition' => response_content_disposition,
      'response-content-encoding'    => response_content_encoding,
      'response-content-language'    => response_content_language,
      'response-content-type'        => response_content_type,
      'response-expires'             => response_expires
    },
    request_headers:  {
      'If-Match'                           => if_match,
      'If-Modified-Since'                  => if_modified_since,
      'If-None-Match'                      => if_none_match,
      'If-Unmodified-Since'                => if_unmodified_since,
      'Range'                              => range,
      'X-QS-Encryption-Customer-Algorithm' => x_qs_encryption_customer_algorithm,
      'X-QS-Encryption-Customer-Key'       => x_qs_encryption_customer_key,
      'X-QS-Encryption-Customer-Key-MD5'   => x_qs_encryption_customer_key_md5
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200,
      206,
      304,
      412
    ]
  }

  get_object_input_validate input
  Request.new input
end

#get_policyObject

get_bucket_policy: Get policy information of the bucket. Documentation URL: https://docs.qingcloud.com/qingstor/api/bucket/policy/get_policy.html



724
725
726
727
# File 'lib/qingstor/sdk/service/bucket.rb', line 724

def get_policy
  request = get_policy_request
  request.send
end

#get_policy_requestObject



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
# File 'lib/qingstor/sdk/service/bucket.rb', line 729

def get_policy_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket Policy',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?policy',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_policy_input_validate input
  Request.new input
end

#get_replicationObject

get_bucket_replication: Get Replication information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/replication/get_replication.html



763
764
765
766
# File 'lib/qingstor/sdk/service/bucket.rb', line 763

def get_replication
  request = get_replication_request
  request.send
end

#get_replication_requestObject



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
# File 'lib/qingstor/sdk/service/bucket.rb', line 768

def get_replication_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket Replication',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?replication',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_replication_input_validate input
  Request.new input
end

#get_statisticsObject

get_bucket_statistics: Get statistics information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/get_stats.html



802
803
804
805
# File 'lib/qingstor/sdk/service/bucket.rb', line 802

def get_statistics
  request = get_statistics_request
  request.send
end

#get_statistics_requestObject



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
# File 'lib/qingstor/sdk/service/bucket.rb', line 807

def get_statistics_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket Statistics',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?stats',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  get_bucket_statistics_input_validate input
  Request.new input
end

#headObject

head_bucket: Check whether the bucket exists and available. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/head.html



841
842
843
844
# File 'lib/qingstor/sdk/service/bucket.rb', line 841

def head
  request = head_request
  request.send
end

#head_object(object_key, if_match: '', if_modified_since: '', if_none_match: '', if_unmodified_since: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '') ⇒ Object

head_object: Check whether the object exists and available. Documentation URL: docs.qingcloud.com/qingstor/api/object/head.html



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/qingstor/sdk/service/object.rb', line 345

def head_object(object_key, if_match: '',
                if_modified_since: '',
                if_none_match: '',
                if_unmodified_since: '',
                x_qs_encryption_customer_algorithm: '',
                x_qs_encryption_customer_key: '',
                x_qs_encryption_customer_key_md5: '')
  request = head_object_request object_key, if_match:                           if_match,
                                            if_modified_since:                  if_modified_since,
                                            if_none_match:                      if_none_match,
                                            if_unmodified_since:                if_unmodified_since,
                                            x_qs_encryption_customer_algorithm: x_qs_encryption_customer_algorithm,
                                            x_qs_encryption_customer_key:       x_qs_encryption_customer_key,
                                            x_qs_encryption_customer_key_md5:   x_qs_encryption_customer_key_md5
  request.send
end

#head_object_request(object_key, if_match: '', if_modified_since: '', if_none_match: '', if_unmodified_since: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '') ⇒ Object



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'lib/qingstor/sdk/service/object.rb', line 362

def head_object_request(object_key, if_match: '',
                        if_modified_since: '',
                        if_none_match: '',
                        if_unmodified_since: '',
                        x_qs_encryption_customer_algorithm: '',
                        x_qs_encryption_customer_key: '',
                        x_qs_encryption_customer_key_md5: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'HEAD Object',
    request_method:   'HEAD',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
    },
    request_headers:  {
      'If-Match'                           => if_match,
      'If-Modified-Since'                  => if_modified_since,
      'If-None-Match'                      => if_none_match,
      'If-Unmodified-Since'                => if_unmodified_since,
      'X-QS-Encryption-Customer-Algorithm' => x_qs_encryption_customer_algorithm,
      'X-QS-Encryption-Customer-Key'       => x_qs_encryption_customer_key,
      'X-QS-Encryption-Customer-Key-MD5'   => x_qs_encryption_customer_key_md5
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  head_object_input_validate input
  Request.new input
end

#head_requestObject



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
# File 'lib/qingstor/sdk/service/bucket.rb', line 846

def head_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'HEAD Bucket',
    request_method:   'HEAD',
    request_uri:      '/<bucket-name>',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  head_bucket_input_validate input
  Request.new input
end

#image_process(object_key, action: '', response_cache_control: '', response_content_disposition: '', response_content_encoding: '', response_content_language: '', response_content_type: '', response_expires: '', if_modified_since: '') ⇒ Object

image_process: Image process with the action on the object Documentation URL: docs.qingcloud.com/qingstor/data_process/image_process/index.html



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/qingstor/sdk/service/object.rb', line 410

def image_process(object_key, action: '',
                  response_cache_control: '',
                  response_content_disposition: '',
                  response_content_encoding: '',
                  response_content_language: '',
                  response_content_type: '',
                  response_expires: '', if_modified_since: '')
  request = image_process_request object_key, action: action,
    response_cache_control: response_cache_control,
    response_content_disposition: response_content_disposition,
    response_content_encoding: response_content_encoding,
    response_content_language: response_content_language,
    response_content_type: response_content_type,
    response_expires: response_expires, if_modified_since: if_modified_since
  request.send
end

#image_process_request(object_key, action: '', response_cache_control: '', response_content_disposition: '', response_content_encoding: '', response_content_language: '', response_content_type: '', response_expires: '', if_modified_since: '') ⇒ Object



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
454
455
456
457
458
459
460
461
462
463
464
465
# File 'lib/qingstor/sdk/service/object.rb', line 427

def image_process_request(object_key, action: '',
                          response_cache_control: '',
                          response_content_disposition: '',
                          response_content_encoding: '',
                          response_content_language: '',
                          response_content_type: '',
                          response_expires: '', if_modified_since: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Image Process',
    request_method:   'GET',
    request_uri:      '/<bucket-name>/<object-key>?image',
    request_params:   {
      'action'                       => action,
      'response-cache-control'       => response_cache_control,
      'response-content-disposition' => response_content_disposition,
      'response-content-encoding'    => response_content_encoding,
      'response-content-language'    => response_content_language,
      'response-content-type'        => response_content_type,
      'response-expires'             => response_expires
    },
    request_headers:  {
      'If-Modified-Since' => if_modified_since
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200,
      304
    ]
  }

  image_process_input_validate input
  Request.new input
end

#initiate_multipart_upload(object_key, content_type: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', x_qs_meta_data: {}, x_qs_storage_class: '') ⇒ Object

initiate_multipart_upload: Initial multipart upload on the object. Documentation URL: docs.qingcloud.com/qingstor/api/object/initiate_multipart_upload.html



481
482
483
484
485
486
487
488
489
490
491
492
493
494
# File 'lib/qingstor/sdk/service/object.rb', line 481

def initiate_multipart_upload(object_key, content_type: '',
                              x_qs_encryption_customer_algorithm: '',
                              x_qs_encryption_customer_key: '',
                              x_qs_encryption_customer_key_md5: '',
                              x_qs_meta_data: {},
                              x_qs_storage_class: '')
  request = initiate_multipart_upload_request object_key, content_type:                       content_type,
                                                          x_qs_encryption_customer_algorithm: x_qs_encryption_customer_algorithm,
                                                          x_qs_encryption_customer_key:       x_qs_encryption_customer_key,
                                                          x_qs_encryption_customer_key_md5:   x_qs_encryption_customer_key_md5,
                                                          x_qs_meta_data:                     ,
                                                          x_qs_storage_class:                 x_qs_storage_class
  request.send
end

#initiate_multipart_upload_request(object_key, content_type: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', x_qs_meta_data: {}, x_qs_storage_class: '') ⇒ Object



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
521
522
523
524
525
526
527
528
529
530
# File 'lib/qingstor/sdk/service/object.rb', line 496

def initiate_multipart_upload_request(object_key, content_type: '',
                                      x_qs_encryption_customer_algorithm: '',
                                      x_qs_encryption_customer_key: '',
                                      x_qs_encryption_customer_key_md5: '',
                                      x_qs_meta_data: {},
                                      x_qs_storage_class: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Initiate Multipart Upload',
    request_method:   'POST',
    request_uri:      '/<bucket-name>/<object-key>?uploads',
    request_params:   {
    },
    request_headers:  {
      'Content-Type'                       => content_type,
      'X-QS-Encryption-Customer-Algorithm' => x_qs_encryption_customer_algorithm,
      'X-QS-Encryption-Customer-Key'       => x_qs_encryption_customer_key,
      'X-QS-Encryption-Customer-Key-MD5'   => x_qs_encryption_customer_key_md5,
      'X-QS-MetaData'                      => ,
      'X-QS-Storage-Class'                 => x_qs_storage_class
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  initiate_multipart_upload_input_validate input
  Request.new input
end

#list_multipart(object_key, limit: nil, part_number_marker: nil, upload_id: '') ⇒ Object

list_multipart: List object parts. Documentation URL: docs.qingcloud.com/qingstor/api/object/list_multipart.html



553
554
555
556
557
558
559
560
# File 'lib/qingstor/sdk/service/object.rb', line 553

def list_multipart(object_key, limit: nil,
                   part_number_marker: nil,
                   upload_id: '')
  request = list_multipart_request object_key, limit:              limit,
                                               part_number_marker: part_number_marker,
                                               upload_id:          upload_id
  request.send
end

#list_multipart_request(object_key, limit: nil, part_number_marker: nil, upload_id: '') ⇒ Object



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
# File 'lib/qingstor/sdk/service/object.rb', line 562

def list_multipart_request(object_key, limit: nil,
                           part_number_marker: nil,
                           upload_id: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'List Multipart',
    request_method:   'GET',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
      'limit'              => limit,
      'part_number_marker' => part_number_marker,
      'upload_id'          => upload_id
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  list_multipart_input_validate input
  Request.new input
end

#list_multipart_uploads(delimiter: '', key_marker: '', limit: nil, prefix: '', upload_id_marker: '') ⇒ Object

list_multipart_uploads: List multipart uploads in the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/list_multipart_uploads.html



880
881
882
883
884
885
886
887
888
889
890
891
# File 'lib/qingstor/sdk/service/bucket.rb', line 880

def list_multipart_uploads(delimiter: '',
                           key_marker: '',
                           limit: nil,
                           prefix: '',
                           upload_id_marker: '')
  request = list_multipart_uploads_request delimiter:        delimiter,
                                           key_marker:       key_marker,
                                           limit:            limit,
                                           prefix:           prefix,
                                           upload_id_marker: upload_id_marker
  request.send
end

#list_multipart_uploads_request(delimiter: '', key_marker: '', limit: nil, prefix: '', upload_id_marker: '') ⇒ Object



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
# File 'lib/qingstor/sdk/service/bucket.rb', line 893

def list_multipart_uploads_request(delimiter: '',
                                   key_marker: '',
                                   limit: nil,
                                   prefix: '',
                                   upload_id_marker: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'List Multipart Uploads',
    request_method:   'GET',
    request_uri:      '/<bucket-name>?uploads',
    request_params:   {
      'delimiter'        => delimiter,
      'key_marker'       => key_marker,
      'limit'            => limit,
      'prefix'           => prefix,
      'upload_id_marker' => upload_id_marker
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  list_multipart_uploads_input_validate input
  Request.new input
end

#list_objects(delimiter: '', limit: nil, marker: '', prefix: '') ⇒ Object

list_objects: Retrieve the object list in a bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/get.html



936
937
938
939
940
941
942
943
944
945
# File 'lib/qingstor/sdk/service/bucket.rb', line 936

def list_objects(delimiter: '',
                 limit: nil,
                 marker: '',
                 prefix: '')
  request = list_objects_request delimiter: delimiter,
                                 limit:     limit,
                                 marker:    marker,
                                 prefix:    prefix
  request.send
end

#list_objects_request(delimiter: '', limit: nil, marker: '', prefix: '') ⇒ Object



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/qingstor/sdk/service/bucket.rb', line 947

def list_objects_request(delimiter: '',
                         limit: nil,
                         marker: '',
                         prefix: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'GET Bucket (List Objects)',
    request_method:   'GET',
    request_uri:      '/<bucket-name>',
    request_params:   {
      'delimiter' => delimiter,
      'limit'     => limit,
      'marker'    => marker,
      'prefix'    => prefix
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  list_objects_input_validate input
  Request.new input
end

#options_object(object_key, access_control_request_headers: '', access_control_request_method: '', origin: '') ⇒ Object

options_object: Check whether the object accepts a origin with method and header. Documentation URL: docs.qingcloud.com/qingstor/api/object/options.html



606
607
608
609
610
611
612
613
# File 'lib/qingstor/sdk/service/object.rb', line 606

def options_object(object_key, access_control_request_headers: '',
                   access_control_request_method: '',
                   origin: '')
  request = options_object_request object_key, access_control_request_headers: access_control_request_headers,
                                               access_control_request_method:  access_control_request_method,
                                               origin:                         origin
  request.send
end

#options_object_request(object_key, access_control_request_headers: '', access_control_request_method: '', origin: '') ⇒ Object



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
643
644
645
# File 'lib/qingstor/sdk/service/object.rb', line 615

def options_object_request(object_key, access_control_request_headers: '',
                           access_control_request_method: '',
                           origin: '')
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'OPTIONS Object',
    request_method:   'OPTIONS',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
    },
    request_headers:  {
      'Access-Control-Request-Headers' => access_control_request_headers,
      'Access-Control-Request-Method'  => access_control_request_method,
      'Origin'                         => origin
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      200,
      304,
      412
    ]
  }

  options_object_input_validate input
  Request.new input
end

#putObject

put_bucket: Create a new bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/put.html



988
989
990
991
# File 'lib/qingstor/sdk/service/bucket.rb', line 988

def put
  request = put_request
  request.send
end

#put_acl(acl: []) ⇒ Object

put_bucket_acl: Set ACL information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/put_acl.html



1027
1028
1029
1030
# File 'lib/qingstor/sdk/service/bucket.rb', line 1027

def put_acl(acl: [])
  request = put_acl_request acl: acl
  request.send
end

#put_acl_request(acl: []) ⇒ Object



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'lib/qingstor/sdk/service/bucket.rb', line 1032

def put_acl_request(acl: [])
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket ACL',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?acl',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'acl' => acl
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_acl_input_validate input
  Request.new input
end

#put_cname(domain: '', type: '') ⇒ Object

put_bucket_cname: Set bucket CNAME of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/cname/put_cname.html



1107
1108
1109
1110
1111
1112
# File 'lib/qingstor/sdk/service/bucket.rb', line 1107

def put_cname(domain: '',
              type: '')
  request = put_cname_request domain: domain,
                              type:   type
  request.send
end

#put_cname_request(domain: '', type: '') ⇒ Object



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
# File 'lib/qingstor/sdk/service/bucket.rb', line 1114

def put_cname_request(domain: '',
                      type: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket CNAME',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?cname',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'domain' => domain,
      'type'   => type
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_cname_input_validate input
  Request.new input
end

#put_cors(cors_rules: []) ⇒ Object

put_bucket_cors: Set CORS information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/cors/put_cors.html



1166
1167
1168
1169
# File 'lib/qingstor/sdk/service/bucket.rb', line 1166

def put_cors(cors_rules: [])
  request = put_cors_request cors_rules: cors_rules
  request.send
end

#put_cors_request(cors_rules: []) ⇒ Object



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/qingstor/sdk/service/bucket.rb', line 1171

def put_cors_request(cors_rules: [])
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket CORS',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?cors',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'cors_rules' => cors_rules
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_cors_input_validate input
  Request.new input
end

#put_external_mirror(source_site: '') ⇒ Object

put_bucket_external_mirror: Set external mirror of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/external_mirror/put_external_mirror.html



1220
1221
1222
1223
# File 'lib/qingstor/sdk/service/bucket.rb', line 1220

def put_external_mirror(source_site: '')
  request = put_external_mirror_request source_site: source_site
  request.send
end

#put_external_mirror_request(source_site: '') ⇒ Object



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
# File 'lib/qingstor/sdk/service/bucket.rb', line 1225

def put_external_mirror_request(source_site: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket External Mirror',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?mirror',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'source_site' => source_site
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_external_mirror_input_validate input
  Request.new input
end

#put_lifecycle(rule: []) ⇒ Object

put_bucket_lifecycle: Set Lifecycle information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/lifecycle/put_lifecycle.html



1264
1265
1266
1267
# File 'lib/qingstor/sdk/service/bucket.rb', line 1264

def put_lifecycle(rule: [])
  request = put_lifecycle_request rule: rule
  request.send
end

#put_lifecycle_request(rule: []) ⇒ Object



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/qingstor/sdk/service/bucket.rb', line 1269

def put_lifecycle_request(rule: [])
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket Lifecycle',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?lifecycle',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'rule' => rule
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_lifecycle_input_validate input
  Request.new input
end

#put_logging(target_bucket: '', target_prefix: '') ⇒ Object

put_bucket_logging: Set bucket logging of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/logging/put_logging.html



1359
1360
1361
1362
1363
1364
# File 'lib/qingstor/sdk/service/bucket.rb', line 1359

def put_logging(target_bucket: '',
                target_prefix: '')
  request = put_logging_request target_bucket: target_bucket,
                                target_prefix: target_prefix
  request.send
end

#put_logging_request(target_bucket: '', target_prefix: '') ⇒ Object



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
# File 'lib/qingstor/sdk/service/bucket.rb', line 1366

def put_logging_request(target_bucket: '',
                        target_prefix: '')
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket Logging',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?logging',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'target_bucket' => target_bucket,
      'target_prefix' => target_prefix
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_logging_input_validate input
  Request.new input
end

#put_notification(notifications: []) ⇒ Object

put_bucket_notification: Set Notification information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/notification/put_notification.html



1411
1412
1413
1414
# File 'lib/qingstor/sdk/service/bucket.rb', line 1411

def put_notification(notifications: [])
  request = put_notification_request notifications: notifications
  request.send
end

#put_notification_request(notifications: []) ⇒ Object



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/qingstor/sdk/service/bucket.rb', line 1416

def put_notification_request(notifications: [])
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket Notification',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?notification',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'notifications' => notifications
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_notification_input_validate input
  Request.new input
end

#put_object(object_key, cache_control: '', content_encoding: '', content_length: nil, content_md5: '', content_type: '', expect: '', x_qs_copy_source: '', x_qs_copy_source_encryption_customer_algorithm: '', x_qs_copy_source_encryption_customer_key: '', x_qs_copy_source_encryption_customer_key_md5: '', x_qs_copy_source_if_match: '', x_qs_copy_source_if_modified_since: '', x_qs_copy_source_if_none_match: '', x_qs_copy_source_if_unmodified_since: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', x_qs_fetch_if_unmodified_since: '', x_qs_fetch_source: '', x_qs_meta_data: {}, x_qs_metadata_directive: '', x_qs_move_source: '', x_qs_storage_class: '', body: nil) ⇒ Object

put_object: Upload the object. Documentation URL: docs.qingcloud.com/qingstor/api/object/put.html



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
705
706
707
708
709
710
711
712
713
714
# File 'lib/qingstor/sdk/service/object.rb', line 665

def put_object(object_key, cache_control: '',
               content_encoding: '',
               content_length: nil,
               content_md5: '',
               content_type: '',
               expect: '',
               x_qs_copy_source: '',
               x_qs_copy_source_encryption_customer_algorithm: '',
               x_qs_copy_source_encryption_customer_key: '',
               x_qs_copy_source_encryption_customer_key_md5: '',
               x_qs_copy_source_if_match: '',
               x_qs_copy_source_if_modified_since: '',
               x_qs_copy_source_if_none_match: '',
               x_qs_copy_source_if_unmodified_since: '',
               x_qs_encryption_customer_algorithm: '',
               x_qs_encryption_customer_key: '',
               x_qs_encryption_customer_key_md5: '',
               x_qs_fetch_if_unmodified_since: '',
               x_qs_fetch_source: '',
               x_qs_meta_data: {},
               x_qs_metadata_directive: '',
               x_qs_move_source: '',
               x_qs_storage_class: '',
               body: nil)
  request = put_object_request object_key, cache_control:                                  cache_control,
                                           content_encoding:                               content_encoding,
                                           content_length:                                 content_length,
                                           content_md5:                                    content_md5,
                                           content_type:                                   content_type,
                                           expect:                                         expect,
                                           x_qs_copy_source:                               x_qs_copy_source,
                                           x_qs_copy_source_encryption_customer_algorithm: x_qs_copy_source_encryption_customer_algorithm,
                                           x_qs_copy_source_encryption_customer_key:       x_qs_copy_source_encryption_customer_key,
                                           x_qs_copy_source_encryption_customer_key_md5:   x_qs_copy_source_encryption_customer_key_md5,
                                           x_qs_copy_source_if_match:                      x_qs_copy_source_if_match,
                                           x_qs_copy_source_if_modified_since:             x_qs_copy_source_if_modified_since,
                                           x_qs_copy_source_if_none_match:                 x_qs_copy_source_if_none_match,
                                           x_qs_copy_source_if_unmodified_since:           x_qs_copy_source_if_unmodified_since,
                                           x_qs_encryption_customer_algorithm:             x_qs_encryption_customer_algorithm,
                                           x_qs_encryption_customer_key:                   x_qs_encryption_customer_key,
                                           x_qs_encryption_customer_key_md5:               x_qs_encryption_customer_key_md5,
                                           x_qs_fetch_if_unmodified_since:                 x_qs_fetch_if_unmodified_since,
                                           x_qs_fetch_source:                              x_qs_fetch_source,
                                           x_qs_meta_data:                                 ,
                                           x_qs_metadata_directive:                        ,
                                           x_qs_move_source:                               x_qs_move_source,
                                           x_qs_storage_class:                             x_qs_storage_class,
                                           body:                                           body
  request.send
end

#put_object_request(object_key, cache_control: '', content_encoding: '', content_length: nil, content_md5: '', content_type: '', expect: '', x_qs_copy_source: '', x_qs_copy_source_encryption_customer_algorithm: '', x_qs_copy_source_encryption_customer_key: '', x_qs_copy_source_encryption_customer_key_md5: '', x_qs_copy_source_if_match: '', x_qs_copy_source_if_modified_since: '', x_qs_copy_source_if_none_match: '', x_qs_copy_source_if_unmodified_since: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', x_qs_fetch_if_unmodified_since: '', x_qs_fetch_source: '', x_qs_meta_data: {}, x_qs_metadata_directive: '', x_qs_move_source: '', x_qs_storage_class: '', body: nil) ⇒ Object



716
717
718
719
720
721
722
723
724
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
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# File 'lib/qingstor/sdk/service/object.rb', line 716

def put_object_request(object_key, cache_control: '',
                       content_encoding: '',
                       content_length: nil,
                       content_md5: '',
                       content_type: '',
                       expect: '',
                       x_qs_copy_source: '',
                       x_qs_copy_source_encryption_customer_algorithm: '',
                       x_qs_copy_source_encryption_customer_key: '',
                       x_qs_copy_source_encryption_customer_key_md5: '',
                       x_qs_copy_source_if_match: '',
                       x_qs_copy_source_if_modified_since: '',
                       x_qs_copy_source_if_none_match: '',
                       x_qs_copy_source_if_unmodified_since: '',
                       x_qs_encryption_customer_algorithm: '',
                       x_qs_encryption_customer_key: '',
                       x_qs_encryption_customer_key_md5: '',
                       x_qs_fetch_if_unmodified_since: '',
                       x_qs_fetch_source: '',
                       x_qs_meta_data: {},
                       x_qs_metadata_directive: '',
                       x_qs_move_source: '',
                       x_qs_storage_class: '',
                       body: nil)
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Object',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
    },
    request_headers:  {
      'Cache-Control'                                  => cache_control,
      'Content-Encoding'                               => content_encoding,
      'Content-Length'                                 => content_length,
      'Content-MD5'                                    => content_md5,
      'Content-Type'                                   => content_type,
      'Expect'                                         => expect,
      'X-QS-Copy-Source'                               => x_qs_copy_source,
      'X-QS-Copy-Source-Encryption-Customer-Algorithm' => x_qs_copy_source_encryption_customer_algorithm,
      'X-QS-Copy-Source-Encryption-Customer-Key'       => x_qs_copy_source_encryption_customer_key,
      'X-QS-Copy-Source-Encryption-Customer-Key-MD5'   => x_qs_copy_source_encryption_customer_key_md5,
      'X-QS-Copy-Source-If-Match'                      => x_qs_copy_source_if_match,
      'X-QS-Copy-Source-If-Modified-Since'             => x_qs_copy_source_if_modified_since,
      'X-QS-Copy-Source-If-None-Match'                 => x_qs_copy_source_if_none_match,
      'X-QS-Copy-Source-If-Unmodified-Since'           => x_qs_copy_source_if_unmodified_since,
      'X-QS-Encryption-Customer-Algorithm'             => x_qs_encryption_customer_algorithm,
      'X-QS-Encryption-Customer-Key'                   => x_qs_encryption_customer_key,
      'X-QS-Encryption-Customer-Key-MD5'               => x_qs_encryption_customer_key_md5,
      'X-QS-Fetch-If-Unmodified-Since'                 => x_qs_fetch_if_unmodified_since,
      'X-QS-Fetch-Source'                              => x_qs_fetch_source,
      'X-QS-MetaData'                                  => ,
      'X-QS-Metadata-Directive'                        => ,
      'X-QS-Move-Source'                               => x_qs_move_source,
      'X-QS-Storage-Class'                             => x_qs_storage_class
    },
    request_elements: {
    },
    request_body:     body,

    status_code:      [
      201
    ]
  }

  put_object_input_validate input
  Request.new input
end

#put_policy(statement: []) ⇒ Object

put_bucket_policy: Set policy information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/policy/put_policy.html



1488
1489
1490
1491
# File 'lib/qingstor/sdk/service/bucket.rb', line 1488

def put_policy(statement: [])
  request = put_policy_request statement: statement
  request.send
end

#put_policy_request(statement: []) ⇒ Object



1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
# File 'lib/qingstor/sdk/service/bucket.rb', line 1493

def put_policy_request(statement: [])
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket Policy',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?policy',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'statement' => statement
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_policy_input_validate input
  Request.new input
end

#put_replication(rules: []) ⇒ Object

put_bucket_replication: Set Replication information of the bucket. Documentation URL: docs.qingcloud.com/qingstor/api/bucket/replication/put_replication.html



1585
1586
1587
1588
# File 'lib/qingstor/sdk/service/bucket.rb', line 1585

def put_replication(rules: [])
  request = put_replication_request rules: rules
  request.send
end

#put_replication_request(rules: []) ⇒ Object



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'lib/qingstor/sdk/service/bucket.rb', line 1590

def put_replication_request(rules: [])
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket Replication',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>?replication',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
      'rules' => rules
    },
    request_body:     nil,

    status_code:      [
      200
    ]
  }

  put_bucket_replication_input_validate input
  Request.new input
end

#put_requestObject



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
# File 'lib/qingstor/sdk/service/bucket.rb', line 993

def put_request
  input = {
    config:           config,
    properties:       properties,
    api_name:         'PUT Bucket',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>',
    request_params:   {
    },
    request_headers:  {
    },
    request_elements: {
    },
    request_body:     nil,

    status_code:      [
      201
    ]
  }

  put_bucket_input_validate input
  Request.new input
end

#upload_multipart(object_key, part_number: nil, upload_id: '', content_length: nil, content_md5: '', x_qs_copy_range: '', x_qs_copy_source: '', x_qs_copy_source_encryption_customer_algorithm: '', x_qs_copy_source_encryption_customer_key: '', x_qs_copy_source_encryption_customer_key_md5: '', x_qs_copy_source_if_match: '', x_qs_copy_source_if_modified_since: '', x_qs_copy_source_if_none_match: '', x_qs_copy_source_if_unmodified_since: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', body: nil) ⇒ Object

upload_multipart: Upload object multipart. Documentation URL: docs.qingcloud.com/qingstor/api/object/multipart/upload_multipart.html



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
850
851
852
# File 'lib/qingstor/sdk/service/object.rb', line 819

def upload_multipart(object_key, part_number: nil,
                     upload_id: '', content_length: nil,
                     content_md5: '',
                     x_qs_copy_range: '',
                     x_qs_copy_source: '',
                     x_qs_copy_source_encryption_customer_algorithm: '',
                     x_qs_copy_source_encryption_customer_key: '',
                     x_qs_copy_source_encryption_customer_key_md5: '',
                     x_qs_copy_source_if_match: '',
                     x_qs_copy_source_if_modified_since: '',
                     x_qs_copy_source_if_none_match: '',
                     x_qs_copy_source_if_unmodified_since: '',
                     x_qs_encryption_customer_algorithm: '',
                     x_qs_encryption_customer_key: '',
                     x_qs_encryption_customer_key_md5: '',
                     body: nil)
  request = upload_multipart_request object_key, part_number: part_number,
    upload_id: upload_id, content_length: content_length,
    content_md5: content_md5,
    x_qs_copy_range: x_qs_copy_range,
    x_qs_copy_source: x_qs_copy_source,
    x_qs_copy_source_encryption_customer_algorithm: x_qs_copy_source_encryption_customer_algorithm,
    x_qs_copy_source_encryption_customer_key: x_qs_copy_source_encryption_customer_key,
    x_qs_copy_source_encryption_customer_key_md5: x_qs_copy_source_encryption_customer_key_md5,
    x_qs_copy_source_if_match: x_qs_copy_source_if_match,
    x_qs_copy_source_if_modified_since: x_qs_copy_source_if_modified_since,
    x_qs_copy_source_if_none_match: x_qs_copy_source_if_none_match,
    x_qs_copy_source_if_unmodified_since: x_qs_copy_source_if_unmodified_since,
    x_qs_encryption_customer_algorithm: x_qs_encryption_customer_algorithm,
    x_qs_encryption_customer_key: x_qs_encryption_customer_key,
    x_qs_encryption_customer_key_md5: x_qs_encryption_customer_key_md5,
    body: body
  request.send
end

#upload_multipart_request(object_key, part_number: nil, upload_id: '', content_length: nil, content_md5: '', x_qs_copy_range: '', x_qs_copy_source: '', x_qs_copy_source_encryption_customer_algorithm: '', x_qs_copy_source_encryption_customer_key: '', x_qs_copy_source_encryption_customer_key_md5: '', x_qs_copy_source_if_match: '', x_qs_copy_source_if_modified_since: '', x_qs_copy_source_if_none_match: '', x_qs_copy_source_if_unmodified_since: '', x_qs_encryption_customer_algorithm: '', x_qs_encryption_customer_key: '', x_qs_encryption_customer_key_md5: '', body: nil) ⇒ Object



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'lib/qingstor/sdk/service/object.rb', line 854

def upload_multipart_request(object_key, part_number: nil,
                             upload_id: '', content_length: nil,
                             content_md5: '',
                             x_qs_copy_range: '',
                             x_qs_copy_source: '',
                             x_qs_copy_source_encryption_customer_algorithm: '',
                             x_qs_copy_source_encryption_customer_key: '',
                             x_qs_copy_source_encryption_customer_key_md5: '',
                             x_qs_copy_source_if_match: '',
                             x_qs_copy_source_if_modified_since: '',
                             x_qs_copy_source_if_none_match: '',
                             x_qs_copy_source_if_unmodified_since: '',
                             x_qs_encryption_customer_algorithm: '',
                             x_qs_encryption_customer_key: '',
                             x_qs_encryption_customer_key_md5: '',
                             body: nil)
  properties[:'object-key'] = object_key
  input = {
    config:           config,
    properties:       properties,
    api_name:         'Upload Multipart',
    request_method:   'PUT',
    request_uri:      '/<bucket-name>/<object-key>',
    request_params:   {
      'part_number' => part_number,
      'upload_id'   => upload_id
    },
    request_headers:  {
      'Content-Length'                                 => content_length,
      'Content-MD5'                                    => content_md5,
      'X-QS-Copy-Range'                                => x_qs_copy_range,
      'X-QS-Copy-Source'                               => x_qs_copy_source,
      'X-QS-Copy-Source-Encryption-Customer-Algorithm' => x_qs_copy_source_encryption_customer_algorithm,
      'X-QS-Copy-Source-Encryption-Customer-Key'       => x_qs_copy_source_encryption_customer_key,
      'X-QS-Copy-Source-Encryption-Customer-Key-MD5'   => x_qs_copy_source_encryption_customer_key_md5,
      'X-QS-Copy-Source-If-Match'                      => x_qs_copy_source_if_match,
      'X-QS-Copy-Source-If-Modified-Since'             => x_qs_copy_source_if_modified_since,
      'X-QS-Copy-Source-If-None-Match'                 => x_qs_copy_source_if_none_match,
      'X-QS-Copy-Source-If-Unmodified-Since'           => x_qs_copy_source_if_unmodified_since,
      'X-QS-Encryption-Customer-Algorithm'             => x_qs_encryption_customer_algorithm,
      'X-QS-Encryption-Customer-Key'                   => x_qs_encryption_customer_key,
      'X-QS-Encryption-Customer-Key-MD5'               => x_qs_encryption_customer_key_md5
    },
    request_elements: {
    },
    request_body:     body,

    status_code:      [
      201
    ]
  }

  upload_multipart_input_validate input
  Request.new input
end