Modulemd.Obsoletes¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (mdversion, modified, module_name, module_stream, message)
	`copy` ()
	`get_eol_date` ()
	`get_message` ()
	`get_modified` ()
	`get_module_context` ()
	`get_obsoleted_by_module_name` ()
	`get_obsoleted_by_module_stream` ()
	`get_reset` ()
	`is_active` ()
	`set_eol_date` (eol_date)
	`set_modified` (modified)
	`set_module_context` (module_context)
	`set_obsoleted_by` (obsoleted_by_module_name, obsoleted_by_module_stream)
	`set_reset` (reset)
	`validate` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`eol-date`	`int`	r/w/c	A string representing UTC date in ISO 8601 format: YYYY-MM-DDTHH:MMZ
`mdversion`	`int`	r/w/co	The metadata version of this obsoletes object.
`message`	`str`	r/w/co	A string describing the change, reason, etc.
`modified`	`int`	r/w/c	The last modified time represented as a 64-bit integer (such as 201807011200)
`module-context`	`str`	r/w/c	The name of the module context to which this obsoletes applies.
`module-name`	`str`	r/w/co	The name of the module to which this obsoletes applies.
`module-stream`	`str`	r/w/co	The name of the module stream to which this obsoletes applies.
`obsoleted-by-module-name`	`str`	r/w/c	Name of the module that obsoletes this one.
`obsoleted-by-module-stream`	`str`	r/w/c	Stream of the module that obsoletes this one.
`override-previous`	`bool`	r/w/c	A boolean option to cancel/reset all previously specified obsoletes.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Modulemd.Obsoletes(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Modulemd.ObsoletesClass

classmethod new(mdversion, modified, module_name, module_stream, message)¶

Parameters:

mdversion (int) – The metadata version of this Modulemd.Obsoletes.
modified (int) – The last modified time represented as a 64-bit integer (such as 201807011200).
module_name (str) – The name of the module to which this obsoletes applies.
module_stream (str) – The name of the module stream to which this obsoletes applies.
message (str) – A string describing the change, reason, etc.

Returns:

A newly-allocated Modulemd.Obsoletes object. This object must be freed with GObject.Object.unref().

Return type:

Modulemd.Obsoletes

New in version 2.10.

copy()¶

Returns:: The copied Modulemd.Obsoletes object.
Return type:: Modulemd.Obsoletes

Create a copy of this Modulemd.Obsoletes object.

New in version 2.10.

get_eol_date()¶

Returns:: A date represented as a 64-bit integer (such as 201807011200).
Return type:: int

New in version 2.10.

get_message()¶

Returns:: The message associated with this Modulemd.Obsoletes object
Return type:: str

New in version 2.10.

get_modified()¶

Returns:: The last modified time of this Modulemd.Obsoletes object represented as a 64-bit integer (such as 201807011200).
Return type:: int

New in version 2.10.

get_module_context()¶

Returns:: The context name to which this Modulemd.Obsoletes object applies.
Return type:: str

New in version 2.10.

get_obsoleted_by_module_name()¶

Returns:: The module name of obsoleting stream.
Return type:: str

New in version 2.10.

get_obsoleted_by_module_stream()¶

Returns:: The module stream of obsoleting stream.
Return type:: str

New in version 2.10.

get_reset()¶

Returns:: Whether this Modulemd.Obsoletes object cancels/resets all previously specified obsoletes.
Return type:: bool

New in version 2.10.

is_active()¶

Returns:: If this Modulemd.Obsoletes object has eol_date set and the date has not occurred yet it returns false otherwise it returns true. (When eol_date is not set or it already occurred the obsoletes is active.)
Return type:: bool

New in version 2.10.

set_eol_date(eol_date)¶

Parameters:: eol_date (int) – The end-of-life date for this stream. If set to zero, the stream is EOLed immediately.

New in version 2.10.

set_modified(modified)¶

Parameters:: modified (int) – The last modified time represented as a 64-bit integer (such as 201807011200).

New in version 2.10.

set_module_context(module_context)¶

Parameters:: module_context (str or None) – The name of the module context to which this obsoletes applies.

New in version 2.10.

set_obsoleted_by(obsoleted_by_module_name, obsoleted_by_module_stream)¶

Parameters:

obsoleted_by_module_name (str) – The module name of obsoleting stream.
obsoleted_by_module_stream (str) – The module stream of obsoleting stream.

Sets both obsoleted by module name and stream because having one without the other is invalid.

New in version 2.10.

set_reset(reset)¶

Parameters:: reset (bool) – Whether to reset/cancel all previously specified obsoletes.

Sets the reset attribute on Modulemd.Obsoletes object. With this boolean attribute set the obsoletes resets (cancels out) all previously specified obsoletes.

New in version 2.10.

validate()¶

Raises:: GLib.Error
Return type:: bool

This method ensures that the obsoletes is internally consistent for usage or dumping to YAML. It will be run implicitly prior to emitting YAML. This is not a complete linter, merely a sanity check that the values are not impossible.

New in version 2.10.

Property Details¶

Modulemd.Obsoletes.props.eol_date¶

Name:: eol-date
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

A string representing UTC date in ISO 8601 format: YYYY-MM-DDTHH:MMZ

Modulemd.Obsoletes.props.mdversion¶

Name:: mdversion
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The metadata version of this obsoletes object.

Modulemd.Obsoletes.props.message¶

Name:: message
Type:: str
Default Value:: '__obsoletes_VALUE_UNSET__'
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

A string describing the change, reason, etc.

Modulemd.Obsoletes.props.modified¶

Name:: modified
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

The last modified time represented as a 64-bit integer (such as 201807011200)

Modulemd.Obsoletes.props.module_context¶

Name:: module-context
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

The name of the module context to which this obsoletes applies.

Modulemd.Obsoletes.props.module_name¶

Name:: module-name
Type:: str
Default Value:: '__obsoletes_VALUE_UNSET__'
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the module to which this obsoletes applies.

Modulemd.Obsoletes.props.module_stream¶

Name:: module-stream
Type:: str
Default Value:: '__obsoletes_VALUE_UNSET__'
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the module stream to which this obsoletes applies.

Modulemd.Obsoletes.props.obsoleted_by_module_name¶

Name:: obsoleted-by-module-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Name of the module that obsoletes this one.

Modulemd.Obsoletes.props.obsoleted_by_module_stream¶

Name:: obsoleted-by-module-stream
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Stream of the module that obsoletes this one.

Modulemd.Obsoletes.props.override_previous¶

Name:: override-previous
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

A boolean option to cancel/reset all previously specified obsoletes.