class PulpcoreClient::DomainsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulpcore_client/api/domains_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create(domain, opts = {}) click to toggle source

Create a domain ViewSet for Domain. NOTE: This API endpoint is in "tech preview" and subject to change @param domain [Domain] @param [Hash] opts the optional parameters @return [DomainResponse]

# File lib/pulpcore_client/api/domains_api.rb, line 27
def create(domain, opts = {})
  data, _status_code, _headers = create_with_http_info(domain, opts)
  data
end
create_with_http_info(domain, opts = {}) click to toggle source

Create a domain ViewSet for Domain. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param domain [Domain] @param [Hash] opts the optional parameters @return [Array<(DomainResponse, Integer, Hash)>] DomainResponse data, response status code and response headers

# File lib/pulpcore_client/api/domains_api.rb, line 37
def create_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.create ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/domains/'

  # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(domain) 

  # return_type
  return_type = opts[:return_type] || 'DomainResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(domain_href, opts = {}) click to toggle source

Delete a domain Trigger an asynchronous delete task @param domain_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulpcore_client/api/domains_api.rb, line 91
def delete(domain_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(domain_href, opts)
  data
end
delete_with_http_info(domain_href, opts = {}) click to toggle source

Delete a domain Trigger an asynchronous delete task @param domain_href [String] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulpcore_client/api/domains_api.rb, line 101
def delete_with_http_info(domain_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.delete ...'
  end
  # verify the required parameter 'domain_href' is set
  if @api_client.config.client_side_validation && domain_href.nil?
    fail ArgumentError, "Missing the required parameter 'domain_href' when calling DomainsApi.delete"
  end
  # resource path
  local_var_path = '{domain_href}'.sub('{' + 'domain_href' + '}', CGI.escape(domain_href.to_s).gsub('%2F', '/'))

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

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

List domains ViewSet for Domain. NOTE: This API endpoint is in "tech preview" and subject to change @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [String] :name__iexact Filter results where name matches value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__iregex Filter results where name matches regex value @option opts [String] :name__istartswith Filter results where name starts with value @option opts [String] :name__regex Filter results where name matches regex value @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;storage_class&#x60; - Storage class * &#x60;-storage_class&#x60; - Storage class (descending) * &#x60;storage_settings&#x60; - Storage settings * &#x60;-storage_settings&#x60; - Storage settings (descending) * &#x60;redirect_to_object_storage&#x60; - Redirect to object storage * &#x60;-redirect_to_object_storage&#x60; - Redirect to object storage (descending) * &#x60;hide_guarded_distributions&#x60; - Hide guarded distributions * &#x60;-hide_guarded_distributions&#x60; - Hide guarded distributions (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas. @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas. @option opts [String] :q @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [PaginatedDomainResponseList]

# File lib/pulpcore_client/api/domains_api.rb, line 169
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

List domains ViewSet for Domain. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [String] :name__iexact Filter results where name matches value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__iregex Filter results where name matches regex value @option opts [String] :name__istartswith Filter results where name starts with value @option opts [String] :name__regex Filter results where name matches regex value @option opts [String] :name__startswith Filter results where name starts with value @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;storage_class&#x60; - Storage class * &#x60;-storage_class&#x60; - Storage class (descending) * &#x60;storage_settings&#x60; - Storage settings * &#x60;-storage_settings&#x60; - Storage settings (descending) * &#x60;redirect_to_object_storage&#x60; - Redirect to object storage * &#x60;-redirect_to_object_storage&#x60; - Redirect to object storage (descending) * &#x60;hide_guarded_distributions&#x60; - Hide guarded distributions * &#x60;-hide_guarded_distributions&#x60; - Hide guarded distributions (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas. @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas. @option opts [String] :q @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedDomainResponseList, Integer, Hash)>] PaginatedDomainResponseList data, response status code and response headers

# File lib/pulpcore_client/api/domains_api.rb, line 195
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.list ...'
  end
  allowable_values = ["-description", "-hide_guarded_distributions", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-redirect_to_object_storage", "-storage_class", "-storage_settings", "description", "hide_guarded_distributions", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "redirect_to_object_storage", "storage_class", "storage_settings"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/domains/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil?
  query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil?
  query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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] || 'PaginatedDomainResponseList' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  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: DomainsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
partial_update(domain_href, patched_domain, opts = {}) click to toggle source

Update a domain Trigger an asynchronous partial update task @param domain_href [String] @param patched_domain [PatchedDomain] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulpcore_client/api/domains_api.rb, line 265
def partial_update(domain_href, patched_domain, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(domain_href, patched_domain, opts)
  data
end
partial_update_with_http_info(domain_href, patched_domain, opts = {}) click to toggle source

Update a domain Trigger an asynchronous partial update task @param domain_href [String] @param patched_domain [PatchedDomain] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulpcore_client/api/domains_api.rb, line 276
def partial_update_with_http_info(domain_href, patched_domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.partial_update ...'
  end
  # verify the required parameter 'domain_href' is set
  if @api_client.config.client_side_validation && domain_href.nil?
    fail ArgumentError, "Missing the required parameter 'domain_href' when calling DomainsApi.partial_update"
  end
  # verify the required parameter 'patched_domain' is set
  if @api_client.config.client_side_validation && patched_domain.nil?
    fail ArgumentError, "Missing the required parameter 'patched_domain' when calling DomainsApi.partial_update"
  end
  # resource path
  local_var_path = '{domain_href}'.sub('{' + 'domain_href' + '}', CGI.escape(domain_href.to_s).gsub('%2F', '/'))

  # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(patched_domain) 

  # return_type
  return_type = opts[:return_type] || 'AsyncOperationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(domain_href, opts = {}) click to toggle source

Inspect a domain ViewSet for Domain. NOTE: This API endpoint is in "tech preview" and subject to change @param domain_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [DomainResponse]

# File lib/pulpcore_client/api/domains_api.rb, line 336
def read(domain_href, opts = {})
  data, _status_code, _headers = read_with_http_info(domain_href, opts)
  data
end
read_with_http_info(domain_href, opts = {}) click to toggle source

Inspect a domain ViewSet for Domain. NOTE: This API endpoint is in "tech preview&quot; and subject to change @param domain_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(DomainResponse, Integer, Hash)>] DomainResponse data, response status code and response headers

# File lib/pulpcore_client/api/domains_api.rb, line 348
def read_with_http_info(domain_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.read ...'
  end
  # verify the required parameter 'domain_href' is set
  if @api_client.config.client_side_validation && domain_href.nil?
    fail ArgumentError, "Missing the required parameter 'domain_href' when calling DomainsApi.read"
  end
  # resource path
  local_var_path = '{domain_href}'.sub('{' + 'domain_href' + '}', CGI.escape(domain_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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] || 'DomainResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  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: DomainsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(domain_href, domain, opts = {}) click to toggle source

Update a domain Trigger an asynchronous update task @param domain_href [String] @param domain [Domain] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulpcore_client/api/domains_api.rb, line 403
def update(domain_href, domain, opts = {})
  data, _status_code, _headers = update_with_http_info(domain_href, domain, opts)
  data
end
update_with_http_info(domain_href, domain, opts = {}) click to toggle source

Update a domain Trigger an asynchronous update task @param domain_href [String] @param domain [Domain] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulpcore_client/api/domains_api.rb, line 414
def update_with_http_info(domain_href, domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.update ...'
  end
  # verify the required parameter 'domain_href' is set
  if @api_client.config.client_side_validation && domain_href.nil?
    fail ArgumentError, "Missing the required parameter 'domain_href' when calling DomainsApi.update"
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling DomainsApi.update"
  end
  # resource path
  local_var_path = '{domain_href}'.sub('{' + 'domain_href' + '}', CGI.escape(domain_href.to_s).gsub('%2F', '/'))

  # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(domain) 

  # return_type
  return_type = opts[:return_type] || 'AsyncOperationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth']

  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: DomainsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end