PulpRpmClient::ContentModulemdsApi

All URIs are relative to http://pulp

Method	HTTP request	Description
create	POST /pulp/api/v3/content/rpm/modulemds/	Create a modulemd
list	GET /pulp/api/v3/content/rpm/modulemds/	List modulemds
read	GET rpm_modulemd_href	Inspect a modulemd

create

AsyncOperationResponse create(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts)

Create a modulemd

Trigger an asynchronous task to create content,optionally create new repository version.

Example

# load the gem
require 'pulp_rpm_client'
# setup authorization
PulpRpmClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpRpmClient::ContentModulemdsApi.new
relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
name = 'name_example' # String | Modulemd name.
stream = 'stream_example' # String | Stream name.
version = 'version_example' # String | Modulemd version.
context = 'context_example' # String | Modulemd context.
arch = 'arch_example' # String | Modulemd architecture.
artifacts = nil # Object | Modulemd artifacts.
dependencies = nil # Object | Modulemd dependencies.
opts = {
  artifact: 'artifact_example', # String | Artifact file representing the physical content
  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
  repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
  packages: 'packages_example' # Array<String> | Modulemd artifacts' packages.
}

begin
  #Create a modulemd
  result = api_instance.create(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts)
  p result
rescue PulpRpmClient::ApiError => e
  puts "Exception when calling ContentModulemdsApi->create: #{e}"
end

Parameters

Name	Type	Description	Notes
relative_path	String	Path where the artifact is located relative to distributions base_path
name	String	Modulemd name.
stream	String	Stream name.
version	String	Modulemd version.
context	String	Modulemd context.
arch	String	Modulemd architecture.
artifacts	Object	Modulemd artifacts.
dependencies	Object	Modulemd dependencies.
artifact	String	Artifact file representing the physical content	[optional]
file	File	An uploaded file that may be turned into the artifact of the content unit.	[optional]
repository	String	A URI of a repository the new content unit should be associated with.	[optional]
packages	Array<String>	Modulemd artifacts' packages.	[optional]

Return type

AsyncOperationResponse

Authorization

basicAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

list

InlineResponse2003 list(opts)

List modulemds

ViewSet for Modulemd.

Example

# load the gem
require 'pulp_rpm_client'
# setup authorization
PulpRpmClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpRpmClient::ContentModulemdsApi.new
opts = {
  limit: 56, # Integer | Number of results to return per page.
  name: 'name_example', # String | name
  name__in: 'name__in_example', # String | name__in
  offset: 56, # Integer | The initial index from which to return the results.
  ordering: 'ordering_example', # String | Which field to use when ordering the results.
  repository_version: 'repository_version_example', # String | repository_version
  repository_version_added: 'repository_version_added_example', # String | repository_version_added
  repository_version_removed: 'repository_version_removed_example', # String | repository_version_removed
  sha256: 'sha256_example', # String | sha256
  stream: 'stream_example', # String | stream
  stream__in: 'stream__in_example', # String | stream__in
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}

begin
  #List modulemds
  result = api_instance.list(opts)
  p result
rescue PulpRpmClient::ApiError => e
  puts "Exception when calling ContentModulemdsApi->list: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer	Number of results to return per page.	[optional]
name	String	name	[optional]
name__in	String	name__in	[optional]
offset	Integer	The initial index from which to return the results.	[optional]
ordering	String	Which field to use when ordering the results.	[optional]
repository_version	String	repository_version	[optional]
repository_version_added	String	repository_version_added	[optional]
repository_version_removed	String	repository_version_removed	[optional]
sha256	String	sha256	[optional]
stream	String	stream	[optional]
stream__in	String	stream__in	[optional]
fields	String	A list of fields to include in the response.	[optional]
exclude_fields	String	A list of fields to exclude from the response.	[optional]

Return type

InlineResponse2003

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

read

RpmModulemdResponse read(rpm_modulemd_href, opts)

Inspect a modulemd

ViewSet for Modulemd.

Example

# load the gem
require 'pulp_rpm_client'
# setup authorization
PulpRpmClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpRpmClient::ContentModulemdsApi.new
rpm_modulemd_href = 'rpm_modulemd_href_example' # String | 
opts = {
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}

begin
  #Inspect a modulemd
  result = api_instance.read(rpm_modulemd_href, opts)
  p result
rescue PulpRpmClient::ApiError => e
  puts "Exception when calling ContentModulemdsApi->read: #{e}"
end

Parameters

Name	Type	Description	Notes
rpm_modulemd_href	String
fields	String	A list of fields to include in the response.	[optional]
exclude_fields	String	A list of fields to exclude from the response.	[optional]

Return type

RpmModulemdResponse

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json