Class: Aws::BackupStorage::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BackupStorage::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-backupstorage/client.rb
Overview
An API client for BackupStorage. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::BackupStorage::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#delete_object(params = {}) ⇒ Struct
Delete Object from the incremental base Backup.
-
#get_chunk(params = {}) ⇒ Types::GetChunkOutput
Gets the specified object’s chunk.
-
#get_object_metadata(params = {}) ⇒ Types::GetObjectMetadataOutput
Get metadata associated with an Object.
-
#list_chunks(params = {}) ⇒ Types::ListChunksOutput
List chunks in a given Object.
-
#list_objects(params = {}) ⇒ Types::ListObjectsOutput
List all Objects in a given Backup.
-
#notify_object_complete(params = {}) ⇒ Types::NotifyObjectCompleteOutput
Complete upload.
-
#put_chunk(params = {}) ⇒ Types::PutChunkOutput
Upload chunk.
-
#put_object(params = {}) ⇒ Types::PutObjectOutput
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
-
#start_object(params = {}) ⇒ Types::StartObjectOutput
Start upload containing one or many chunks.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 410 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
884 885 886 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 884 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
887 888 889 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 887 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
862 863 864 865 866 867 868 869 870 871 872 873 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 862 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-backupstorage' context[:gem_version] = '1.16.0' Seahorse::Client::Request.new(handlers, context) end |
#delete_object(params = {}) ⇒ Struct
Delete Object from the incremental base Backup.
437 438 439 440 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 437 def delete_object(params = {}, = {}) req = build_request(:delete_object, params) req.send_request() end |
#get_chunk(params = {}) ⇒ Types::GetChunkOutput
Gets the specified object’s chunk.
475 476 477 478 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 475 def get_chunk(params = {}, = {}, &block) req = build_request(:get_chunk, params) req.send_request(, &block) end |
#get_object_metadata(params = {}) ⇒ Types::GetObjectMetadataOutput
Get metadata associated with an Object.
515 516 517 518 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 515 def (params = {}, = {}, &block) req = build_request(:get_object_metadata, params) req.send_request(, &block) end |
#list_chunks(params = {}) ⇒ Types::ListChunksOutput
List chunks in a given Object
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
564 565 566 567 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 564 def list_chunks(params = {}, = {}) req = build_request(:list_chunks, params) req.send_request() end |
#list_objects(params = {}) ⇒ Types::ListObjectsOutput
List all Objects in a given Backup.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
628 629 630 631 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 628 def list_objects(params = {}, = {}) req = build_request(:list_objects, params) req.send_request() end |
#notify_object_complete(params = {}) ⇒ Types::NotifyObjectCompleteOutput
Complete upload
691 692 693 694 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 691 def notify_object_complete(params = {}, = {}) req = build_request(:notify_object_complete, params) req.send_request() end |
#put_chunk(params = {}) ⇒ Types::PutChunkOutput
Upload chunk.
745 746 747 748 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 745 def put_chunk(params = {}, = {}) req = build_request(:put_chunk, params) req.send_request() end |
#put_object(params = {}) ⇒ Types::PutObjectOutput
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
817 818 819 820 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 817 def put_object(params = {}, = {}) req = build_request(:put_object, params) req.send_request() end |
#start_object(params = {}) ⇒ Types::StartObjectOutput
Start upload containing one or many chunks.
853 854 855 856 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 853 def start_object(params = {}, = {}) req = build_request(:start_object, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
877 878 879 |
# File 'lib/aws-sdk-backupstorage/client.rb', line 877 def waiter_names [] end |