sushy.resources.settings
Module¶sushy.resources.settings.
MaintenanceWindowField
(*args, **kwargs)¶Bases: sushy.resources.base.CompositeField
maintenance_window_duration_in_seconds
= <sushy.resources.base.Field object>¶The expiry time of maintenance window in seconds
maintenance_window_start_time
= <sushy.resources.base.Field object>¶The start time of a maintenance window
sushy.resources.settings.
MessageListField
(*args, **kwargs)¶Bases: sushy.resources.base.ListField
List of messages with details of settings update status
message
= <sushy.resources.base.Field object>¶Human readable message, if provided
message_args
= <sushy.resources.base.Field object>¶List of message substitution arguments for the message referenced by message_id from the message registry
message_id
= <sushy.resources.base.Field object>¶The key for this message which can be used to look up the message in a message registry
resolution
= <sushy.resources.base.Field object>¶Used to provide suggestions on how to resolve the situation that caused the error
severity
= <sushy.resources.base.MappedField object>¶Severity of the error
sushy.resources.settings.
NO_UPDATES
= 4¶No updates made
sushy.resources.settings.
SettingsApplyTimeField
¶Bases: sushy.resources.base.CompositeField
apply_time
= <sushy.resources.base.Field object>¶When the future configuration should be applied
apply_time_allowable_values
= <sushy.resources.base.Field object>¶The list of allowable ApplyTime values
maintenance_window_duration_in_seconds
= <sushy.resources.base.Field object>¶The expiry time of maintenance window in seconds
maintenance_window_start_time
= <sushy.resources.base.Field object>¶The start time of a maintenance window
sushy.resources.settings.
SettingsField
¶Bases: sushy.resources.base.CompositeField
The settings of a resource
Represents the future state and configuration of the resource. The field is added to resources that support future state and configuration.
This field includes several properties to help clients monitor when the resource is consumed by the service and determine the results of applying the values, which may or may not have been successful.
commit
(connector, value)¶Commits new settings values
The new values will be applied when the system or a service restarts.
connector – A Connector instance
value – Value representing JSON whose structure is specific to each resource and the caller must format it correctly
get_status
(registries)¶Determines the status of last update based
Uses message id-s and severity to determine the status.
registries – registries to use to parse message
SettingsUpdate
object containing status
and any messages
maintenance_window
¶MaintenanceWindow field
Indicates if a given resource has a maintenance window assignment for applying settings or operations
messages
= <sushy.resources.settings.MessageListField object>¶Represents the results of the last time the values of the Settings resource were applied to the server
operation_apply_time_support
¶OperationApplyTimeSupport field
Indicates if a client is allowed to request for a specific apply time of a create, delete, or action operation of a given resource
resource_uri
¶time
= <sushy.resources.base.Field object>¶Indicates the time the settings were applied to the server
sushy.resources.settings.
SettingsUpdate
(status, messages)¶Bases: object
Contains Settings update status and details of the update
messages
¶List of MessageListField
with messages from the update
status
¶The status of the update
sushy.resources.settings.
UPDATE_FAILURE
= 2¶Update encountered errors
sushy.resources.settings.
UPDATE_PENDING
= 3¶Update waiting for being applied
sushy.resources.settings.
UPDATE_SUCCESS
= 1¶Update was successful
sushy.resources.settings.
UPDATE_UNKNOWN
= 0¶Update status unknown
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.