Top |
Modulemd.ModuleStreamV1Modulemd.ModuleStreamV1 — The data to represent a stream of a module as described by a modulemd YAML document of version 1. |
ModulemdModuleStreamV1 * modulemd_module_stream_v1_new (const gchar *module_name
,const gchar *module_stream
);
A newly-allocated ModulemdModuleStreamV1 object, with the specified module and stream names, if provided.
Since: 2.0
void modulemd_module_stream_v1_set_arch (ModulemdModuleStreamV1 *self
,const gchar *arch
);
Set the module artifact architecture.
self |
This ModulemdModuleStreamV1 object. |
[in] |
arch |
The module artifact architecture. |
[in] |
Since: 2.0
const gchar *
modulemd_module_stream_v1_get_arch (ModulemdModuleStreamV1 *self
);
Since: 2.0
void modulemd_module_stream_v1_set_buildopts (ModulemdModuleStreamV1 *self
,ModulemdBuildopts *buildopts
);
Set build options for this module's components.
self |
This ModulemdModuleStreamV1 object. |
[in] |
buildopts |
A ModulemdBuildOpts object describing build options that apply globally to components in this module. |
[in][transfer none] |
Since: 2.0
ModulemdBuildopts *
modulemd_module_stream_v1_get_buildopts
(ModulemdModuleStreamV1 *self
);
Since: 2.0
void modulemd_module_stream_v1_set_community (ModulemdModuleStreamV1 *self
,const gchar *community
);
Set the module community website address.
self |
This ModulemdModuleStreamV1 object. |
[in] |
community |
The upstream community website for this module. |
[in] |
Since: 2.0
const gchar *
modulemd_module_stream_v1_get_community
(ModulemdModuleStreamV1 *self
);
Since: 2.0
void modulemd_module_stream_v1_set_description (ModulemdModuleStreamV1 *self
,const gchar *description
);
Set the module description.
self |
This ModulemdModuleStreamV1 object. |
[in] |
description |
The untranslated description of this module. |
[in][nullable] |
Since: 2.0
const gchar * modulemd_module_stream_v1_get_description (ModulemdModuleStreamV1 *self
,const gchar *locale
);
Since: 2.0
void modulemd_module_stream_v1_set_documentation (ModulemdModuleStreamV1 *self
,const gchar *documentation
);
Set the module documentation website address.
self |
This ModulemdModuleStreamV1 object. |
[in] |
documentation |
The upstream documentation website for this module. |
[in] |
Since: 2.0
const gchar *
modulemd_module_stream_v1_get_documentation
(ModulemdModuleStreamV1 *self
);
Since: 2.0
void modulemd_module_stream_v1_set_summary (ModulemdModuleStreamV1 *self
,const gchar *summary
);
Set the module summary.
self |
This ModulemdModuleStreamV1 object. |
[in] |
summary |
The untranslated summary of this module. |
[in][nullable] |
Since: 2.0
const gchar * modulemd_module_stream_v1_get_summary (ModulemdModuleStreamV1 *self
,const gchar *locale
);
Since: 2.0
void modulemd_module_stream_v1_set_tracker (ModulemdModuleStreamV1 *self
,const gchar *tracker
);
Set the module bug tracker website address.
self |
This ModulemdModuleStreamV1 object. |
[in] |
tracker |
The upstream bug tracker website for this module. |
[in] |
Since: 2.0
const gchar *
modulemd_module_stream_v1_get_tracker (ModulemdModuleStreamV1 *self
);
Since: 2.0
void modulemd_module_stream_v1_add_component (ModulemdModuleStreamV1 *self
,ModulemdComponent *component
);
Add a component definition to the module.
self |
This ModulemdModuleStreamV1 object. |
[in] |
component |
A ModulemdComponent to be added to this module stream. |
[in][transfer none] |
Since: 2.0
void modulemd_module_stream_v1_remove_module_component (ModulemdModuleStreamV1 *self
,const gchar *component_name
);
Remove a component from this module stream.
self |
This ModulemdModuleStreamV1 object. |
[in] |
component_name |
The name of the component to remove from the module stream. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_rpm_component (ModulemdModuleStreamV1 *self
,const gchar *component_name
);
Remove a component from this module stream.
self |
This ModulemdModuleStreamV1 object. |
[in] |
component_name |
The name of the component to remove from the module stream. |
[in] |
Since: 2.0
GStrv
modulemd_module_stream_v1_get_module_component_names_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_module_component_names]
Since: 2.0
GStrv
modulemd_module_stream_v1_get_rpm_component_names_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_rpm_component_names]
Since: 2.0
ModulemdComponentModule * modulemd_module_stream_v1_get_module_component (ModulemdModuleStreamV1 *self
,const gchar *component_name
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
component_name |
The name of the component to retrieve. |
[in] |
Since: 2.0
ModulemdComponentRpm * modulemd_module_stream_v1_get_rpm_component (ModulemdModuleStreamV1 *self
,const gchar *component_name
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
component_name |
The name of the component to retrieve. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_add_content_license (ModulemdModuleStreamV1 *self
,const gchar *license
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
license |
A license under which one or more of the components of this module stream are distributed. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_add_module_license (ModulemdModuleStreamV1 *self
,const gchar *license
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
license |
A license under which this module stream is distributed. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_content_license (ModulemdModuleStreamV1 *self
,const gchar *license
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
license |
A license to remove from the list. Has no effect if the license is not present. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_module_license (ModulemdModuleStreamV1 *self
,const gchar *license
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
license |
A license to remove from the list. Has no effect if the license is not present. |
[in] |
Since: 2.0
GStrv
modulemd_module_stream_v1_get_content_licenses_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_content_licenses]
An ordered list of licenses under which one or more components of this module stream are released.
Since: 2.0
GStrv
modulemd_module_stream_v1_get_module_licenses_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_module_licenses]
Since: 2.0
void modulemd_module_stream_v1_add_profile (ModulemdModuleStreamV1 *self
,ModulemdProfile *profile
);
Adds a profile definition to this module stream.
self |
This ModulemdModuleStreamV1 object. |
[in] |
profile |
A ModulemdProfile for this module stream. |
[in][transfer none] |
Since: 2.0
void
modulemd_module_stream_v1_clear_profiles
(ModulemdModuleStreamV1 *self
);
Removes all profiles from this module stream.
Since: 2.0
GStrv
modulemd_module_stream_v1_get_profile_names_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_profile_names]
Since: 2.0
ModulemdProfile * modulemd_module_stream_v1_get_profile (ModulemdModuleStreamV1 *self
,const gchar *profile_name
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
profile_name |
The name of a profile to retrieve. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_add_rpm_api (ModulemdModuleStreamV1 *self
,const gchar *rpm
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
rpm |
The name of a binary RPM present in this module that is considered stable public API. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_rpm_api (ModulemdModuleStreamV1 *self
,const gchar *rpm
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
rpm |
A binary RPM name to remove from the list of stable public API. |
[in] |
Since: 2.0
GStrv
modulemd_module_stream_v1_get_rpm_api_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_rpm_api]
Since: 2.0
void modulemd_module_stream_v1_add_rpm_artifact (ModulemdModuleStreamV1 *self
,const gchar *nevr
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
nevr |
The NEVR of a binary RPM present in this module stream. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_rpm_artifact (ModulemdModuleStreamV1 *self
,const gchar *nevr
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
nevr |
An RPM NEVR to remove from the list of artifacts. |
[in] |
Since: 2.0
GStrv
modulemd_module_stream_v1_get_rpm_artifacts_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_rpm_artifacts]
Since: 2.0
void modulemd_module_stream_v1_add_rpm_filter (ModulemdModuleStreamV1 *self
,const gchar *rpm
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
rpm |
The name of a binary RPM to filter out of this module stream. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_rpm_filter (ModulemdModuleStreamV1 *self
,const gchar *rpm
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
rpm |
A binary RPM name to remove from the filter list. |
[in] |
Since: 2.0
GStrv
modulemd_module_stream_v1_get_rpm_filters_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_rpm_filters]
Since: 2.0
void modulemd_module_stream_v1_add_servicelevel (ModulemdModuleStreamV1 *self
,ModulemdServiceLevel *servicelevel
);
Adds a servicelevel definition to this module stream.
self |
This ModulemdModuleStreamV1 object. |
[in] |
servicelevel |
A ModulemdServiceLevel for this module stream. |
[in][transfer none] |
Since: 2.0
void
modulemd_module_stream_v1_clear_servicelevels
(ModulemdModuleStreamV1 *self
);
Removes all servicelevels from this module stream.
Since: 2.0
GStrv
modulemd_module_stream_v1_get_servicelevel_names_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_servicelevel_names]
Since: 2.0
ModulemdServiceLevel * modulemd_module_stream_v1_get_servicelevel (ModulemdModuleStreamV1 *self
,const gchar *servicelevel_name
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
servicelevel_name |
The name of a servicelevel to retrieve. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_set_eol (ModulemdModuleStreamV1 *self
,GDate *eol
);
modulemd_module_stream_v1_set_eol
has been deprecated since version 2.0 and should not be used in newly-written code.
Comptibility function with early iterations of modulemd v1. This function is a wrapper for Modulemd.ModuleStreamV1.add_servicelevel("rawhide", eol).
self |
This ModulemdModuleStreamV1 object. |
[in] |
eol |
The end-of-life date for the "rawhide" service level. |
[in] |
Since: 2.0
GDate *
modulemd_module_stream_v1_get_eol (ModulemdModuleStreamV1 *self
);
modulemd_module_stream_v1_get_eol
has been deprecated since version 2.0 and should not be used in newly-written code.
Compatibility function with early iterations of modulemd v1. This function is a wrapper for Modulemd.ModuleStreamV1.get_servicelevel("rawhide").
Since: 2.0
void modulemd_module_stream_v1_add_buildtime_requirement (ModulemdModuleStreamV1 *self
,const gchar *module_name
,const gchar *module_stream
);
Add a build-time dependency for this module.
self |
This ModulemdModuleStreamV1 object. |
[in] |
module_name |
The name of the module to depend on. |
[in] |
module_stream |
The name of the module stream to depend on. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_add_runtime_requirement (ModulemdModuleStreamV1 *self
,const gchar *module_name
,const gchar *module_stream
);
Add a runtime dependency for this module.
self |
This ModulemdModuleStreamV1 object. |
[in] |
module_name |
The name of the module to depend on. |
[in] |
module_stream |
The name of the module stream to depend on. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_buildtime_requirement (ModulemdModuleStreamV1 *self
,const gchar *module_name
);
Remove a build-time dependency for this module.
self |
This ModulemdModuleStreamV1 object. |
[in] |
module_name |
The name of the module to be removed. |
[in] |
Since: 2.0
void modulemd_module_stream_v1_remove_runtime_requirement (ModulemdModuleStreamV1 *self
,const gchar *module_name
);
Remove a runtime dependency for this module.
self |
This ModulemdModuleStreamV1 object. |
[in] |
module_name |
The name of the module to be removed. |
[in] |
Since: 2.0
GStrv
modulemd_module_stream_v1_get_buildtime_modules_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_buildtime_modules]
Since: 2.0
GStrv
modulemd_module_stream_v1_get_runtime_modules_as_strv
(ModulemdModuleStreamV1 *self
);
[rename-to modulemd_module_stream_v1_get_runtime_modules]
Since: 2.0
const gchar * modulemd_module_stream_v1_get_buildtime_requirement_stream (ModulemdModuleStreamV1 *self
,const gchar *module_name
);
self |
This ModulemdModuleStreamV1 object. |
[in] |
module_name |
The name of the module this module depends on. |
[in] |
Since: 2.0
const gchar * modulemd_module_stream_v1_get_runtime_requirement_stream (ModulemdModuleStreamV1 *self
,const gchar *module_name
);
void modulemd_module_stream_v1_set_xmd (ModulemdModuleStreamV1 *self
,GVariant *xmd
);
Sets the eXtensible MetaData (XMD) for this module. XMD is arbitrary YAML data that will be set and returned as-is (with the exception that the ordering of mapping keys is not defined). Useful for carrying private data.
This function assumes ownership of the XMD GVariant and thus should not be freed by the caller.
self |
This ModulemdModuleStreamV1 object. |
[in] |
xmd |
A GVariant representing arbitrary YAML. |
[in][transfer full] |
Since: 2.0
GVariant *
modulemd_module_stream_v1_get_xmd (ModulemdModuleStreamV1 *self
);
#define MODULEMD_TYPE_MODULE_STREAM_V1 (modulemd_module_stream_v1_get_type ())
typedef struct { GObject parent_instance; /* Properties */ ModulemdBuildopts *buildopts; gchar *community; gchar *description; gchar *documentation; gchar *summary; gchar *tracker; /* Internal Data Structures */ GHashTable *rpm_components; /* <string, Modulemd.ComponentRpm> */ GHashTable *module_components; /* <string, Modulemd.ComponentModule */ GHashTable *content_licenses; /* string set */ GHashTable *module_licenses; /* string set */ GHashTable *profiles; /* <string, Modulemd.Profile> */ GHashTable *rpm_api; /* string set */ GHashTable *rpm_artifacts; /* string set */ GHashTable *rpm_filters; /* string set */ GHashTable *servicelevels; /* <string, Modulemd.ServiceLevel */ GHashTable *buildtime_deps; /* <string, string> */ GHashTable *runtime_deps; /* <string, string> */ GVariant *xmd; } ModulemdModuleStreamV1;