The sushy.resources.settings Module¶

class 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.Field object>¶

Severity of the error

class 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.

Parameters:	connector – A Connector instance value – Value representing JSON whose structure is specific to each resource and the caller must format it correctly etag – Optional ETag of resource version to update. If this ETag is provided and it does not match on server, then the new values will not be committed

messages = <sushy.resources.settings.MessageListField object>¶

Represents the results of the last time the values of the Settings resource were applied to the server

resource_uri¶

time = <sushy.resources.base.Field object>¶

Indicates the time the settings were applied to the server