class PulpContainerClient::DistributionsContainerApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

add_role(container_container_distribution_href, nested_role, opts = {}) click to toggle source

Add a role for this object to users/groups. @param container_container_distribution_href [String] @param nested_role [NestedRole] @param [Hash] opts the optional parameters @return [NestedRoleResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 27
def add_role(container_container_distribution_href, nested_role, opts = {})
  data, _status_code, _headers = add_role_with_http_info(container_container_distribution_href, nested_role, opts)
  data
end
add_role_with_http_info(container_container_distribution_href, nested_role, opts = {}) click to toggle source

Add a role for this object to users/groups. @param container_container_distribution_href [String] @param nested_role [NestedRole] @param [Hash] opts the optional parameters @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers

# File lib/pulp_container_client/api/distributions_container_api.rb, line 37
def add_role_with_http_info(container_container_distribution_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.add_role ...'
  end
  # verify the required parameter 'container_container_distribution_href' is set
  if @api_client.config.client_side_validation && container_container_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.add_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling DistributionsContainerApi.add_role"
  end
  # resource path
  local_var_path = '{container_container_distribution_href}add_role/'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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(nested_role) 

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

  # 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: DistributionsContainerApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create(container_container_distribution, opts = {}) click to toggle source

Create a container distribution Trigger an asynchronous create task @param container_container_distribution [ContainerContainerDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 95
def create(container_container_distribution, opts = {})
  data, _status_code, _headers = create_with_http_info(container_container_distribution, opts)
  data
end
create_with_http_info(container_container_distribution, opts = {}) click to toggle source

Create a container distribution Trigger an asynchronous create task @param container_container_distribution [ContainerContainerDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_container_client/api/distributions_container_api.rb, line 105
def create_with_http_info(container_container_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.create ...'
  end
  # verify the required parameter 'container_container_distribution' is set
  if @api_client.config.client_side_validation && container_container_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution' when calling DistributionsContainerApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/distributions/container/container/'

  # 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(container_container_distribution) 

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

Delete a container distribution Trigger an asynchronous delete task @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 159
def delete(container_container_distribution_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(container_container_distribution_href, opts)
  data
end
delete_with_http_info(container_container_distribution_href, opts = {}) click to toggle source

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

# File lib/pulp_container_client/api/distributions_container_api.rb, line 169
def delete_with_http_info(container_container_distribution_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.delete ...'
  end
  # verify the required parameter 'container_container_distribution_href' is set
  if @api_client.config.client_side_validation && container_container_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.delete"
  end
  # resource path
  local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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: DistributionsContainerApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

List container distributions The Container Distribution will serve the latest version of a Repository if “repository“ is specified. The Container Distribution will serve a specific repository version if “repository_version“. Note that *either* “repository“ or “repository_version“ can be set on a Container Distribution, but not both. @param [Hash] opts the optional parameters @option opts [String] :base_path @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [String] :namespace__name @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :with_content Filter distributions based on the content served by them @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [PaginatedcontainerContainerDistributionResponseList]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 237
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_roles(container_container_distribution_href, opts = {}) click to toggle source

List roles assigned to this object. @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [ObjectRolesResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 333
def list_roles(container_container_distribution_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(container_container_distribution_href, opts)
  data
end
list_roles_with_http_info(container_container_distribution_href, opts = {}) click to toggle source

List roles assigned to this object. @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'ObjectRolesResponse' 

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

List container distributions The Container Distribution will serve the latest version of a Repository if &#x60;&#x60;repository&#x60;&#x60; is specified. The Container Distribution will serve a specific repository version if &#x60;&#x60;repository_version&#x60;&#x60;. Note that *either* &#x60;&#x60;repository&#x60;&#x60; or &#x60;&#x60;repository_version&#x60;&#x60; can be set on a Container Distribution, but not both. @param [Hash] opts the optional parameters @option opts [String] :base_path @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @option opts [String] :namespace__name @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :with_content Filter distributions based on the content served by them @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedcontainerContainerDistributionResponseList, Integer, Hash)>] PaginatedcontainerContainerDistributionResponseList data, response status code and response headers

# File lib/pulp_container_client/api/distributions_container_api.rb, line 263
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.list ...'
  end
  allowable_values = ["-base_path", "-content_guard", "-description", "-distribution_ptr", "-group_roles", "-name", "-namespace", "-pk", "-private", "-publication", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-remote", "-repository", "-repository_version", "-user_roles", "base_path", "content_guard", "description", "distribution_ptr", "group_roles", "name", "namespace", "pk", "private", "publication", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "remote", "repository", "repository_version", "user_roles"]
  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/distributions/container/container/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'base_path'] = opts[:'base_path'] if !opts[:'base_path'].nil?
  query_params[:'base_path__contains'] = opts[:'base_path__contains'] if !opts[:'base_path__contains'].nil?
  query_params[:'base_path__icontains'] = opts[:'base_path__icontains'] if !opts[:'base_path__icontains'].nil?
  query_params[:'base_path__in'] = @api_client.build_collection_param(opts[:'base_path__in'], :csv) if !opts[:'base_path__in'].nil?
  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__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'namespace__name'] = opts[:'namespace__name'] if !opts[:'namespace__name'].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_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'PaginatedcontainerContainerDistributionResponseList' 

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

List permissions available to the current user on this object. @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [MyPermissionsResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 399
def my_permissions(container_container_distribution_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(container_container_distribution_href, opts)
  data
end
my_permissions_with_http_info(container_container_distribution_href, opts = {}) click to toggle source

List permissions available to the current user on this object. @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'MyPermissionsResponse' 

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

Update a container distribution Trigger an asynchronous partial update task @param container_container_distribution_href [String] @param patchedcontainer_container_distribution [PatchedcontainerContainerDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 465
def partial_update(container_container_distribution_href, patchedcontainer_container_distribution, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution, opts)
  data
end
partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution, opts = {}) click to toggle source

Update a container distribution Trigger an asynchronous partial update task @param container_container_distribution_href [String] @param patchedcontainer_container_distribution [PatchedcontainerContainerDistribution] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_container_client/api/distributions_container_api.rb, line 476
def partial_update_with_http_info(container_container_distribution_href, patchedcontainer_container_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.partial_update ...'
  end
  # verify the required parameter 'container_container_distribution_href' is set
  if @api_client.config.client_side_validation && container_container_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.partial_update"
  end
  # verify the required parameter 'patchedcontainer_container_distribution' is set
  if @api_client.config.client_side_validation && patchedcontainer_container_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'patchedcontainer_container_distribution' when calling DistributionsContainerApi.partial_update"
  end
  # resource path
  local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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(patchedcontainer_container_distribution) 

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

Inspect a container distribution The Container Distribution will serve the latest version of a Repository if “repository“ is specified. The Container Distribution will serve a specific repository version if “repository_version“. Note that *either* “repository“ or “repository_version“ can be set on a Container Distribution, but not both. @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [ContainerContainerDistributionResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 536
def read(container_container_distribution_href, opts = {})
  data, _status_code, _headers = read_with_http_info(container_container_distribution_href, opts)
  data
end
read_with_http_info(container_container_distribution_href, opts = {}) click to toggle source

Inspect a container distribution The Container Distribution will serve the latest version of a Repository if &#x60;&#x60;repository&#x60;&#x60; is specified. The Container Distribution will serve a specific repository version if &#x60;&#x60;repository_version&#x60;&#x60;. Note that *either* &#x60;&#x60;repository&#x60;&#x60; or &#x60;&#x60;repository_version&#x60;&#x60; can be set on a Container Distribution, but not both. @param container_container_distribution_href [String] @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(ContainerContainerDistributionResponse, Integer, Hash)>] ContainerContainerDistributionResponse data, response status code and response headers

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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] || 'ContainerContainerDistributionResponse' 

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

Remove a role for this object from users/groups. @param container_container_distribution_href [String] @param nested_role [NestedRole] @param [Hash] opts the optional parameters @return [NestedRoleResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 602
def remove_role(container_container_distribution_href, nested_role, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(container_container_distribution_href, nested_role, opts)
  data
end
remove_role_with_http_info(container_container_distribution_href, nested_role, opts = {}) click to toggle source

Remove a role for this object from users/groups. @param container_container_distribution_href [String] @param nested_role [NestedRole] @param [Hash] opts the optional parameters @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers

# File lib/pulp_container_client/api/distributions_container_api.rb, line 612
def remove_role_with_http_info(container_container_distribution_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.remove_role ...'
  end
  # verify the required parameter 'container_container_distribution_href' is set
  if @api_client.config.client_side_validation && container_container_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.remove_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling DistributionsContainerApi.remove_role"
  end
  # resource path
  local_var_path = '{container_container_distribution_href}remove_role/'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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(nested_role) 

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

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

Update a container distribution Trigger an asynchronous update task @param container_container_distribution_href [String] @param container_container_distribution [ContainerContainerDistribution] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_container_client/api/distributions_container_api.rb, line 671
def update(container_container_distribution_href, container_container_distribution, opts = {})
  data, _status_code, _headers = update_with_http_info(container_container_distribution_href, container_container_distribution, opts)
  data
end
update_with_http_info(container_container_distribution_href, container_container_distribution, opts = {}) click to toggle source

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

# File lib/pulp_container_client/api/distributions_container_api.rb, line 682
def update_with_http_info(container_container_distribution_href, container_container_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsContainerApi.update ...'
  end
  # verify the required parameter 'container_container_distribution_href' is set
  if @api_client.config.client_side_validation && container_container_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution_href' when calling DistributionsContainerApi.update"
  end
  # verify the required parameter 'container_container_distribution' is set
  if @api_client.config.client_side_validation && container_container_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'container_container_distribution' when calling DistributionsContainerApi.update"
  end
  # resource path
  local_var_path = '{container_container_distribution_href}'.sub('{' + 'container_container_distribution_href' + '}', CGI.escape(container_container_distribution_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(container_container_distribution) 

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