class PulpOstreeClient::RemotesOstreeApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Create an ostree remote A ViewSet class for OSTree remote repositories. @param ostree_ostree_remote [OstreeOstreeRemote] @param [Hash] opts the optional parameters @return [OstreeOstreeRemoteResponse]

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

Create an ostree remote A ViewSet class for OSTree remote repositories. @param ostree_ostree_remote [OstreeOstreeRemote] @param [Hash] opts the optional parameters @return [Array<(OstreeOstreeRemoteResponse, Integer, Hash)>] OstreeOstreeRemoteResponse data, response status code and response headers

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

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

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

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

Delete an ostree remote Trigger an asynchronous delete task @param ostree_ostree_remote_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

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

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

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

List ostree remotes A ViewSet class for OSTree remote repositories. @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__istartswith Filter results where name starts with 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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (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] :pulp_label_select Filter labels by search string @option opts [DateTime] :pulp_last_updated Filter results where pulp_last_updated matches value @option opts [DateTime] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [DateTime] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [DateTime] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [DateTime] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [Array<DateTime>] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @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 [PaginatedostreeOstreeRemoteResponseList]

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

List ostree remotes A ViewSet class for OSTree remote repositories. @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__istartswith Filter results where name starts with 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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (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] :pulp_label_select Filter labels by search string @option opts [DateTime] :pulp_last_updated Filter results where pulp_last_updated matches value @option opts [DateTime] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [DateTime] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [DateTime] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [DateTime] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [Array<DateTime>] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @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<(PaginatedostreeOstreeRemoteResponseList, Integer, Hash)>] PaginatedostreeOstreeRemoteResponseList data, response status code and response headers

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 205
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesOstreeApi.list ...'
  end
  allowable_values = ["-ca_cert", "-client_cert", "-client_key", "-connect_timeout", "-download_concurrency", "-headers", "-max_retries", "-name", "-password", "-pk", "-policy", "-proxy_password", "-proxy_url", "-proxy_username", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-rate_limit", "-sock_connect_timeout", "-sock_read_timeout", "-tls_validation", "-total_timeout", "-url", "-username", "ca_cert", "client_cert", "client_key", "connect_timeout", "download_concurrency", "headers", "max_retries", "name", "password", "pk", "policy", "proxy_password", "proxy_url", "proxy_username", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "rate_limit", "sock_connect_timeout", "sock_read_timeout", "tls_validation", "total_timeout", "url", "username"]
  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/remotes/ostree/ostree/'

  # 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__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].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[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = @api_client.build_collection_param(opts[:'pulp_last_updated__range'], :csv) if !opts[:'pulp_last_updated__range'].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] || 'PaginatedostreeOstreeRemoteResponseList' 

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

Update an ostree remote Trigger an asynchronous partial update task @param ostree_ostree_remote_href [String] @param patchedostree_ostree_remote [PatchedostreeOstreeRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 280
def partial_update(ostree_ostree_remote_href, patchedostree_ostree_remote, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(ostree_ostree_remote_href, patchedostree_ostree_remote, opts)
  data
end
partial_update_with_http_info(ostree_ostree_remote_href, patchedostree_ostree_remote, opts = {}) click to toggle source

Update an ostree remote Trigger an asynchronous partial update task @param ostree_ostree_remote_href [String] @param patchedostree_ostree_remote [PatchedostreeOstreeRemote] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

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

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

Inspect an ostree remote A ViewSet class for OSTree remote repositories. @param ostree_ostree_remote_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 [OstreeOstreeRemoteResponse]

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 351
def read(ostree_ostree_remote_href, opts = {})
  data, _status_code, _headers = read_with_http_info(ostree_ostree_remote_href, opts)
  data
end
read_with_http_info(ostree_ostree_remote_href, opts = {}) click to toggle source

Inspect an ostree remote A ViewSet class for OSTree remote repositories. @param ostree_ostree_remote_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<(OstreeOstreeRemoteResponse, Integer, Hash)>] OstreeOstreeRemoteResponse data, response status code and response headers

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 363
def read_with_http_info(ostree_ostree_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesOstreeApi.read ...'
  end
  # verify the required parameter 'ostree_ostree_remote_href' is set
  if @api_client.config.client_side_validation && ostree_ostree_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ostree_ostree_remote_href' when calling RemotesOstreeApi.read"
  end
  # resource path
  local_var_path = '{ostree_ostree_remote_href}'.sub('{' + 'ostree_ostree_remote_href' + '}', CGI.escape(ostree_ostree_remote_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] || 'OstreeOstreeRemoteResponse' 

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

Set a label Set a single pulp_label on the object to a specific value or null. @param ostree_ostree_remote_href [String] @param set_label [SetLabel] @param [Hash] opts the optional parameters @return [SetLabelResponse]

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 418
def set_label(ostree_ostree_remote_href, set_label, opts = {})
  data, _status_code, _headers = set_label_with_http_info(ostree_ostree_remote_href, set_label, opts)
  data
end
set_label_with_http_info(ostree_ostree_remote_href, set_label, opts = {}) click to toggle source

Set a label Set a single pulp_label on the object to a specific value or null. @param ostree_ostree_remote_href [String] @param set_label [SetLabel] @param [Hash] opts the optional parameters @return [Array<(SetLabelResponse, Integer, Hash)>] SetLabelResponse data, response status code and response headers

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 429
def set_label_with_http_info(ostree_ostree_remote_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesOstreeApi.set_label ...'
  end
  # verify the required parameter 'ostree_ostree_remote_href' is set
  if @api_client.config.client_side_validation && ostree_ostree_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ostree_ostree_remote_href' when calling RemotesOstreeApi.set_label"
  end
  # verify the required parameter 'set_label' is set
  if @api_client.config.client_side_validation && set_label.nil?
    fail ArgumentError, "Missing the required parameter 'set_label' when calling RemotesOstreeApi.set_label"
  end
  # resource path
  local_var_path = '{ostree_ostree_remote_href}set_label/'.sub('{' + 'ostree_ostree_remote_href' + '}', CGI.escape(ostree_ostree_remote_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(set_label) 

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

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

Unset a label Unset a single pulp_label on the object. @param ostree_ostree_remote_href [String] @param unset_label [UnsetLabel] @param [Hash] opts the optional parameters @return [UnsetLabelResponse]

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 488
def unset_label(ostree_ostree_remote_href, unset_label, opts = {})
  data, _status_code, _headers = unset_label_with_http_info(ostree_ostree_remote_href, unset_label, opts)
  data
end
unset_label_with_http_info(ostree_ostree_remote_href, unset_label, opts = {}) click to toggle source

Unset a label Unset a single pulp_label on the object. @param ostree_ostree_remote_href [String] @param unset_label [UnsetLabel] @param [Hash] opts the optional parameters @return [Array<(UnsetLabelResponse, Integer, Hash)>] UnsetLabelResponse data, response status code and response headers

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 499
def unset_label_with_http_info(ostree_ostree_remote_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesOstreeApi.unset_label ...'
  end
  # verify the required parameter 'ostree_ostree_remote_href' is set
  if @api_client.config.client_side_validation && ostree_ostree_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ostree_ostree_remote_href' when calling RemotesOstreeApi.unset_label"
  end
  # verify the required parameter 'unset_label' is set
  if @api_client.config.client_side_validation && unset_label.nil?
    fail ArgumentError, "Missing the required parameter 'unset_label' when calling RemotesOstreeApi.unset_label"
  end
  # resource path
  local_var_path = '{ostree_ostree_remote_href}unset_label/'.sub('{' + 'ostree_ostree_remote_href' + '}', CGI.escape(ostree_ostree_remote_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(unset_label) 

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

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

Update an ostree remote Trigger an asynchronous update task @param ostree_ostree_remote_href [String] @param ostree_ostree_remote [OstreeOstreeRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ostree_client/api/remotes_ostree_api.rb, line 558
def update(ostree_ostree_remote_href, ostree_ostree_remote, opts = {})
  data, _status_code, _headers = update_with_http_info(ostree_ostree_remote_href, ostree_ostree_remote, opts)
  data
end
update_with_http_info(ostree_ostree_remote_href, ostree_ostree_remote, opts = {}) click to toggle source

Update an ostree remote Trigger an asynchronous update task @param ostree_ostree_remote_href [String] @param ostree_ostree_remote [OstreeOstreeRemote] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

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

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