Compose¶
Python objects¶
Message schema for Composes.
Each message is defined as a Python class. For details, see fedora-messaging documentation on messages.
-
class
bodhi.messages.schemas.compose.
ComposeCompleteV1
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
bodhi.messages.schemas.base.BodhiMessage
Sent when a compose task completes.
-
property
ctype
¶ Return the compose type.
-
property
repo
¶ Return the name of the repository being composed.
-
property
success
¶ Return the name of the repository being composed.
-
property
summary
¶ Return a short, human-readable representation of this message.
This should provide a short summary of the message, much like the subject line of an email.
- Returns
The message summary.
-
topic
= 'bodhi.compose.complete'¶
-
property
-
class
bodhi.messages.schemas.compose.
ComposeComposingV1
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
bodhi.messages.schemas.base.BodhiMessage
Sent when the compose task composes.
-
property
repo
¶ Return the name of the repository being composed.
-
property
summary
¶ Return a short, human-readable representation of this message.
This should provide a short summary of the message, much like the subject line of an email.
- Returns
A summary for this message.
-
topic
= 'bodhi.compose.composing'¶
-
property
-
class
bodhi.messages.schemas.compose.
ComposeStartV1
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
bodhi.messages.schemas.base.BodhiMessage
Sent when a compose task starts.
-
property
summary
¶ Return a short, human-readable representation of this message.
This should provide a short summary of the message, much like the subject line of an email.
- Returns
A summary for this message.
-
topic
= 'bodhi.compose.start'¶
-
property
-
class
bodhi.messages.schemas.compose.
ComposeSyncDoneV1
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
bodhi.messages.schemas.base.BodhiMessage
Sent when a compose task sync is done.
-
property
repo
¶ Return the name of the repository being composed.
-
property
summary
¶ Return a short, human-readable representation of this message.
This should provide a short summary of the message, much like the subject line of an email.
- Returns
A summary for this message.
-
topic
= 'bodhi.compose.sync.done'¶
-
property
-
class
bodhi.messages.schemas.compose.
ComposeSyncWaitV1
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
bodhi.messages.schemas.base.BodhiMessage
Sent when a compose task sync is waiting.
-
property
repo
¶ Return the name of the repository being composed.
-
property
summary
¶ Return a short, human-readable representation of this message.
This should provide a short summary of the message, much like the subject line of an email.
- Returns
A summary for this message.
-
topic
= 'bodhi.compose.sync.wait'¶
-
property
-
class
bodhi.messages.schemas.compose.
RepoDoneV1
(body=None, headers=None, topic=None, properties=None, severity=None)[source]¶ Bases:
bodhi.messages.schemas.base.BodhiMessage
Sent when a repo is created and ready to be signed or otherwise processed.
-
property
repo
¶ Return the name of the repository being composed.
-
property
summary
¶ Return a short, human-readable representation of this message.
This should provide a short summary of the message, much like the subject line of an email.
- Returns
A summary for this message.
-
topic
= 'bodhi.repo.done'¶
-
property
JSON schemas¶
bodhi.compose.complete¶
{
"id": "https://bodhi.fedoraproject.org/message-schemas/v1/bodhi.compose.complete#",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for message sent when composes finish",
"type": "object",
"properties": {
"agent": {
"type": "string",
"description": "The name of the user who started this compose."
},
"repo": {
"type": "string",
"description": "The name of the repository being composed."
},
"success": {
"type": "boolean",
"description": "true if the compose was successful, false otherwise."
},
"ctype": {
"type": "string",
"description": "Type of the compose."
}
},
"required": [
"agent",
"repo",
"success"
]
}
bodhi.compose.composing¶
{
"id": "https://bodhi.fedoraproject.org/message-schemas/v1/bodhi.compose.composing#",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for message sent when composes start",
"type": "object",
"properties": {
"agent": {
"type": "string",
"description": "The name of the user who started this compose."
},
"repo": {
"type": "string",
"description": "The name of the repository being composed."
}
},
"required": [
"agent",
"repo"
]
}
bodhi.compose.start¶
{
"id": "https://bodhi.fedoraproject.org/message-schemas/v1/bodhi.compose.start#",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for message sent when composes start",
"type": "object",
"properties": {
"agent": {
"type": "string",
"description": "The name of the user who started this compose."
}
},
"required": [
"agent"
]
}
bodhi.compose.sync.done¶
{
"id": "https://bodhi.fedoraproject.org/message-schemas/v1/bodhi.compose.sync.done#",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for message sent when the composer is done waiting to sync to mirrors",
"type": "object",
"properties": {
"agent": {
"type": "string",
"description": "The name of the user who started this compose."
},
"repo": {
"type": "string",
"description": "The name of the repository being composed."
}
},
"required": [
"agent",
"repo"
]
}
bodhi.compose.sync.wait¶
{
"id": "https://bodhi.fedoraproject.org/message-schemas/v1/bodhi.compose.sync.wait#",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for message sent when the composer is waiting to sync to mirrors",
"type": "object",
"properties": {
"agent": {
"type": "string",
"description": "The name of the user who started this compose."
},
"repo": {
"type": "string",
"description": "The name of the repository being composed."
}
},
"required": [
"agent",
"repo"
]
}
bodhi.repo.done¶
{
"id": "https://bodhi.fedoraproject.org/message-schemas/v1/bodhi.repo.done#",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Schema for message sent when a repo is created and ready to be signed",
"type": "object",
"properties": {
"agent": {
"type": "string",
"description": "The name of the user who started this compose."
},
"path": {
"type": "string",
"description": "The path of the repository that was composed."
},
"repo": {
"type": "string",
"description": "The name of the repository that was composed."
}
},
"required": [
"agent",
"path",
"repo"
]
}