class Nodeum::CloudBucketsApi
Attributes
Public Class Methods
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Lists all cloud buckets. **API Key Scope**: cloud_buckets / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. @option opts [String] :id Filter on id @option opts [String] :cloud_connector_id Filter on cloud connector id @option opts [String] :pool_id Filter on a pool id @option opts [String] :name Filter on name @option opts [String] :location Filter on location @option opts [String] :price Filter on price @return [CloudBucketCollection]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 35 def index_cloud_buckets(opts = {}) data, _status_code, _headers = index_cloud_buckets_with_http_info(opts) data end
Lists all cloud buckets. **API Key Scope**: cloud_buckets / index @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. @option opts [String] :id Filter on id @option opts [String] :pool_id Filter on a pool id @option opts [String] :name Filter on name @option opts [String] :location Filter on location @option opts [String] :price Filter on price @return [CloudBucketCollection]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 118 def index_cloud_buckets_by_cloud_connector(cloud_connector_id, opts = {}) data, _status_code, _headers = index_cloud_buckets_by_cloud_connector_with_http_info(cloud_connector_id, opts) data end
Lists all cloud buckets. **API Key Scope**: cloud_buckets / index @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. @option opts [String] :id Filter on id @option opts [String] :pool_id Filter on a pool id @option opts [String] :name Filter on name @option opts [String] :location Filter on location @option opts [String] :price Filter on price @return [Array<(CloudBucketCollection
, Integer, Hash)>] CloudBucketCollection
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 136 def index_cloud_buckets_by_cloud_connector_with_http_info(cloud_connector_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.index_cloud_buckets_by_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudBucketsApi.index_cloud_buckets_by_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil? query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil? query_params[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil? query_params[:'price'] = opts[:'price'] if !opts[:'price'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucketCollection' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#index_cloud_buckets_by_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Lists all cloud buckets from pool. **API Key Scope**: cloud_buckets / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. @option opts [String] :id Filter on id @option opts [String] :cloud_connector_id Filter on cloud connector id @option opts [String] :name Filter on name @option opts [String] :location Filter on location @option opts [String] :price Filter on price @return [CloudBucketCollection]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 204 def index_cloud_buckets_by_pool(pool_id, opts = {}) data, _status_code, _headers = index_cloud_buckets_by_pool_with_http_info(pool_id, opts) data end
Lists all cloud buckets from pool. **API Key Scope**: cloud_buckets / index @param pool_id [String] Numeric ID, or name of pool. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. @option opts [String] :id Filter on id @option opts [String] :cloud_connector_id Filter on cloud connector id @option opts [String] :name Filter on name @option opts [String] :location Filter on location @option opts [String] :price Filter on price @return [Array<(CloudBucketCollection
, Integer, Hash)>] CloudBucketCollection
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 222 def index_cloud_buckets_by_pool_with_http_info(pool_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.index_cloud_buckets_by_pool ...' end # verify the required parameter 'pool_id' is set if @api_client.config.client_side_validation && pool_id.nil? fail ArgumentError, "Missing the required parameter 'pool_id' when calling CloudBucketsApi.index_cloud_buckets_by_pool" end # resource path local_var_path = '/pools/{pool_id}/cloud_buckets'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil? query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil? query_params[:'cloud_connector_id'] = opts[:'cloud_connector_id'] if !opts[:'cloud_connector_id'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil? query_params[:'price'] = opts[:'price'] if !opts[:'price'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucketCollection' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#index_cloud_buckets_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Lists all cloud buckets. **API Key Scope**: cloud_buckets / index @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. @option opts [String] :id Filter on id @option opts [String] :cloud_connector_id Filter on cloud connector id @option opts [String] :pool_id Filter on a pool id @option opts [String] :name Filter on name @option opts [String] :location Filter on location @option opts [String] :price Filter on price @return [Array<(CloudBucketCollection
, Integer, Hash)>] CloudBucketCollection
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 53 def index_cloud_buckets_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.index_cloud_buckets ...' end # resource path local_var_path = '/cloud_buckets' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil? query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil? query_params[:'cloud_connector_id'] = opts[:'cloud_connector_id'] if !opts[:'cloud_connector_id'].nil? query_params[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil? query_params[:'price'] = opts[:'price'] if !opts[:'price'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucketCollection' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#index_cloud_buckets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [MountStatus]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 282 def mount_status_cloud_bucket(cloud_bucket_id, opts = {}) data, _status_code, _headers = mount_status_cloud_bucket_with_http_info(cloud_bucket_id, opts) data end
Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [MountStatus]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 345 def mount_status_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, opts = {}) data, _status_code, _headers = mount_status_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts) data end
Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [Array<(MountStatus
, Integer, Hash)>] MountStatus
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 356 def mount_status_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.mount_status_cloud_bucket_by_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudBucketsApi.mount_status_cloud_bucket_by_cloud_connector" end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.mount_status_cloud_bucket_by_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}/mount'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'MountStatus' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#mount_status_cloud_bucket_by_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status @param pool_id [String] Numeric ID, or name of pool. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [MountStatus]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 413 def mount_status_cloud_bucket_by_pool(pool_id, cloud_bucket_id, opts = {}) data, _status_code, _headers = mount_status_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts) data end
Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status @param pool_id [String] Numeric ID, or name of pool. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [Array<(MountStatus
, Integer, Hash)>] MountStatus
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 424 def mount_status_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.mount_status_cloud_bucket_by_pool ...' end # verify the required parameter 'pool_id' is set if @api_client.config.client_side_validation && pool_id.nil? fail ArgumentError, "Missing the required parameter 'pool_id' when calling CloudBucketsApi.mount_status_cloud_bucket_by_pool" end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.mount_status_cloud_bucket_by_pool" end # resource path local_var_path = '/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}/mount'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'MountStatus' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#mount_status_cloud_bucket_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get mount status of Cloud bucket. **API Key Scope**: cloud_buckets / mount_status @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [Array<(MountStatus
, Integer, Hash)>] MountStatus
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 292 def mount_status_cloud_bucket_with_http_info(cloud_bucket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.mount_status_cloud_bucket ...' end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.mount_status_cloud_bucket" end # resource path local_var_path = '/cloud_buckets/{cloud_bucket_id}/mount'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'MountStatus' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#mount_status_cloud_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [CloudBucket]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 480 def show_cloud_bucket(cloud_bucket_id, opts = {}) data, _status_code, _headers = show_cloud_bucket_with_http_info(cloud_bucket_id, opts) data end
Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [CloudBucket]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 543 def show_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, opts = {}) data, _status_code, _headers = show_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts) data end
Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [Array<(CloudBucket
, Integer, Hash)>] CloudBucket
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 554 def show_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.show_cloud_bucket_by_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudBucketsApi.show_cloud_bucket_by_cloud_connector" end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.show_cloud_bucket_by_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucket' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#show_cloud_bucket_by_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show @param pool_id [String] Numeric ID, or name of pool. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [CloudBucket]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 611 def show_cloud_bucket_by_pool(pool_id, cloud_bucket_id, opts = {}) data, _status_code, _headers = show_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts) data end
Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show @param pool_id [String] Numeric ID, or name of pool. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [Array<(CloudBucket
, Integer, Hash)>] CloudBucket
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 622 def show_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.show_cloud_bucket_by_pool ...' end # verify the required parameter 'pool_id' is set if @api_client.config.client_side_validation && pool_id.nil? fail ArgumentError, "Missing the required parameter 'pool_id' when calling CloudBucketsApi.show_cloud_bucket_by_pool" end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.show_cloud_bucket_by_pool" end # resource path local_var_path = '/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucket' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#show_cloud_bucket_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Displays a specific cloud bucket. **API Key Scope**: cloud_buckets / show @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param [Hash] opts the optional parameters @return [Array<(CloudBucket
, Integer, Hash)>] CloudBucket
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 490 def show_cloud_bucket_with_http_info(cloud_bucket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.show_cloud_bucket ...' end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.show_cloud_bucket" end # resource path local_var_path = '/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucket' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#show_cloud_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Synchronize internal cloud buckets with their remote equivalent. **API Key Scope**: cloud_buckets / sync @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param [Hash] opts the optional parameters @return [ActiveJobStatus]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 678 def sync_cloud_buckets(cloud_connector_id, opts = {}) data, _status_code, _headers = sync_cloud_buckets_with_http_info(cloud_connector_id, opts) data end
Synchronize internal cloud buckets with their remote equivalent. **API Key Scope**: cloud_buckets / sync @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param [Hash] opts the optional parameters @return [Array<(ActiveJobStatus
, Integer, Hash)>] ActiveJobStatus
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 688 def sync_cloud_buckets_with_http_info(cloud_connector_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.sync_cloud_buckets ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudBucketsApi.sync_cloud_buckets" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ActiveJobStatus' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#sync_cloud_buckets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Check result of cloud connector sync job. **API Key Scope**: cloud_buckets / sync @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param job_id [String] ID of active job @param [Hash] opts the optional parameters @return [CloudBucketSimpleCollection]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 741 def sync_result_cloud_buckets(cloud_connector_id, job_id, opts = {}) data, _status_code, _headers = sync_result_cloud_buckets_with_http_info(cloud_connector_id, job_id, opts) data end
Check result of cloud connector sync job. **API Key Scope**: cloud_buckets / sync @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param job_id [String] ID of active job @param [Hash] opts the optional parameters @return [Array<(CloudBucketSimpleCollection
, Integer, Hash)>] CloudBucketSimpleCollection
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 752 def sync_result_cloud_buckets_with_http_info(cloud_connector_id, job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.sync_result_cloud_buckets ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudBucketsApi.sync_result_cloud_buckets" end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CloudBucketsApi.sync_result_cloud_buckets" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/-/sync'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'job_id'] = job_id # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed', ]) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CloudBucketSimpleCollection' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#sync_result_cloud_buckets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param cloud_bucket_body [CloudBucket] @param [Hash] opts the optional parameters @return [CloudBucket]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 810 def update_cloud_bucket(cloud_bucket_id, cloud_bucket_body, opts = {}) data, _status_code, _headers = update_cloud_bucket_with_http_info(cloud_bucket_id, cloud_bucket_body, opts) data end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param cloud_bucket_body [CloudBucket] @param [Hash] opts the optional parameters @return [CloudBucket]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 881 def update_cloud_bucket_by_cloud_connector(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts = {}) data, _status_code, _headers = update_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts) data end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update @param cloud_connector_id [String] Numeric ID or name of cloud connector. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param cloud_bucket_body [CloudBucket] @param [Hash] opts the optional parameters @return [Array<(CloudBucket
, Integer, Hash)>] CloudBucket
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 893 def update_cloud_bucket_by_cloud_connector_with_http_info(cloud_connector_id, cloud_bucket_id, cloud_bucket_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_cloud_bucket_by_cloud_connector ...' end # verify the required parameter 'cloud_connector_id' is set if @api_client.config.client_side_validation && cloud_connector_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_connector_id' when calling CloudBucketsApi.update_cloud_bucket_by_cloud_connector" end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_cloud_bucket_by_cloud_connector" end # verify the required parameter 'cloud_bucket_body' is set if @api_client.config.client_side_validation && cloud_bucket_body.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_body' when calling CloudBucketsApi.update_cloud_bucket_by_cloud_connector" end # resource path local_var_path = '/cloud_connectors/{cloud_connector_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_connector_id' + '}', CGI.escape(cloud_connector_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(cloud_bucket_body) # return_type return_type = opts[:return_type] || 'CloudBucket' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#update_cloud_bucket_by_cloud_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update @param pool_id [String] Numeric ID, or name of pool. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param cloud_bucket_body [CloudBucket] @param [Hash] opts the optional parameters @return [CloudBucket]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 957 def update_cloud_bucket_by_pool(pool_id, cloud_bucket_id, cloud_bucket_body, opts = {}) data, _status_code, _headers = update_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, cloud_bucket_body, opts) data end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update @param pool_id [String] Numeric ID, or name of pool. @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param cloud_bucket_body [CloudBucket] @param [Hash] opts the optional parameters @return [Array<(CloudBucket
, Integer, Hash)>] CloudBucket
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 969 def update_cloud_bucket_by_pool_with_http_info(pool_id, cloud_bucket_id, cloud_bucket_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_cloud_bucket_by_pool ...' end # verify the required parameter 'pool_id' is set if @api_client.config.client_side_validation && pool_id.nil? fail ArgumentError, "Missing the required parameter 'pool_id' when calling CloudBucketsApi.update_cloud_bucket_by_pool" end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_cloud_bucket_by_pool" end # verify the required parameter 'cloud_bucket_body' is set if @api_client.config.client_side_validation && cloud_bucket_body.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_body' when calling CloudBucketsApi.update_cloud_bucket_by_pool" end # resource path local_var_path = '/pools/{pool_id}/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'pool_id' + '}', CGI.escape(pool_id.to_s)).sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(cloud_bucket_body) # return_type return_type = opts[:return_type] || 'CloudBucket' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#update_cloud_bucket_by_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param cloud_bucket_body [CloudBucket] @param [Hash] opts the optional parameters @return [Array<(CloudBucket
, Integer, Hash)>] CloudBucket
data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 821 def update_cloud_bucket_with_http_info(cloud_bucket_id, cloud_bucket_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_cloud_bucket ...' end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_cloud_bucket" end # verify the required parameter 'cloud_bucket_body' is set if @api_client.config.client_side_validation && cloud_bucket_body.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_body' when calling CloudBucketsApi.update_cloud_bucket" end # resource path local_var_path = '/cloud_buckets/{cloud_bucket_id}'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(cloud_bucket_body) # return_type return_type = opts[:return_type] || 'CloudBucket' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#update_cloud_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update_config_file @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param config_file [File] Config file to upload. @param [Hash] opts the optional parameters @return [String]
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 1032 def update_config_file_cloud_bucket(cloud_bucket_id, config_file, opts = {}) data, _status_code, _headers = update_config_file_cloud_bucket_with_http_info(cloud_bucket_id, config_file, opts) data end
Updates a specific cloud bucket. **API Key Scope**: cloud_buckets / update_config_file @param cloud_bucket_id [String] Numeric ID or name of cloud bucket. @param config_file [File] Config file to upload. @param [Hash] opts the optional parameters @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
# File lib/nodeum_sdk/api/cloud_buckets_api.rb, line 1043 def update_config_file_cloud_bucket_with_http_info(cloud_bucket_id, config_file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CloudBucketsApi.update_config_file_cloud_bucket ...' end # verify the required parameter 'cloud_bucket_id' is set if @api_client.config.client_side_validation && cloud_bucket_id.nil? fail ArgumentError, "Missing the required parameter 'cloud_bucket_id' when calling CloudBucketsApi.update_config_file_cloud_bucket" end # verify the required parameter 'config_file' is set if @api_client.config.client_side_validation && config_file.nil? fail ArgumentError, "Missing the required parameter 'config_file' when calling CloudBucketsApi.update_config_file_cloud_bucket" end # resource path local_var_path = '/cloud_buckets/{cloud_bucket_id}/config_file'.sub('{' + 'cloud_bucket_id' + '}', CGI.escape(cloud_bucket_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = opts[:form_params] || {} form_params['config_file'] = config_file # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'String' # auth_names auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CloudBucketsApi#update_config_file_cloud_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end