changecontrol.v1

name is the name of the action.

timeout is the maximum duration in seconds that

the action can execute before timing out. If this

is not set, then this is interpreted to mean there

is no timeout.

args are the arguments of the action.

key uniquely identifies the change control.

approve is the flag to approve (approve.value set to true)

or unapprove (approve.value set to false) the change control.

version is the timestamp of the change control to approve.

This field must be set when approve.value is set to true

and is intended to safeguard against approving a change control

that has been updated since last read.

name is the name of the change.

root_stage_id is the ID of the root stage or the stage that

should execute first.

stages holds a configuration of stages and their statuses.

notes are any notes associated with the change.

time is the time at which the change was last updated.

user is the user by which the change was last updated.

name is the name of the change.

root_stage_id is the ID of the root stage or the stage that

should execute first.

stages holds a configuration of stages. See StageConfigMap

description for more information.

notes are any notes associated with the change.

key uniquely identifies the change control.

change holds the configuration and status of the change of

the change control.

approve indicates whether the change control was flagged

as approved (approve.value set to true) or unapproved

(approve.value set to false).

start indicates whether the change control was flagged to

start (start.value set to true) or stop (start.value

set to false) execution.

status is the execution status of the change control.

error is any error that occurred during the execution of the

change control.

schedule indicates whether the change control was flagged

to be scheduled (schedule.value set to some timestamp) or

unscheduled (schedule.value set to nil) for execution.

device_ids is a list of device IDs on which the change control will operate.

key uniquely identifies the change control.

change is the change subject to execution.

start is the flag to start (start.value set to true)

or stop (start.value set to false) execution of the

change control.

schedule is the flag to schedule (schedule.value set to

some timestamp) or unschedule (schedule.value set to

nil) the change control for execution.

id is the ID of the change control.

device_ids includes the list of device ids to be matched with devices

in the changecontrol state model.

At least one of the provided device ids must be present in CC devices field.

value is the value of the flag (true or false).

notes are any notes associated with the setting of the flag.

time is the time at which the flag was last updated.

user is the user by which the flag was last updated.

value is the value of the flag (true or false).

notes are any notes associated with the flag value.

values is a list of fmp.RepeatedString.

name is the name of the stage.

action is the action to perform during the stage.

rows is a series of rows of parallel stages referenced

by ID. See StageConfig.rows for more details.

status is the execution status of the stage.

error is any error that occured during the execution

of the stage.

start_time is the time when status change to Running

end_time is the time when status change to Completed

name is the name of the stage.

action is the action to perform on stage execution.

rows is a series of rows of parallel stages referenced

by ID. Each row is run one after the other and the

stages within each row are run in parallel.

For example:

</p><p>[["1a", "1b"], ["2"]]</p><p>

This configures stage 1a and stage 1b to run at the

same time, and then stage 2 once both of them have

completed.

values is a map from stage ID to StageConfig.

values is a map from stage ID to Stage.

value is the value of the flag (some timestamp).

notes are any notes associated with the setting of the flag.

time is the time at which the flag was last updated.

user is the user by which the flag was last updated.

value is the value of the flag (some timestamp).

notes are the notes associated with the flag value.

CHANGE_CONTROL_STATUS_RUNNING means the change control has begun

execution.

CHANGE_CONTROL_STATUS_COMPLETED means the change control has ceased

execution. Success/failure of a change control cannot be inferred

from this status alone but rather this status plus the change control

error. That is, no error implies success and some error implies failure.

CHANGE_CONTROL_STATUS_SCHEDULED means the change control has been

scheduled for execution at some time. Any failure that occurs during

this process will cause a transition back to the unspecified status,

a reset of the schedule flag by the system, and an error on the change

control reporting the details of the failure.

CHANGE_CONTROL_STATUS_NOT_STARTED means the change control has not been

started. This would include approved and not approved change controls.

STAGE_STATUS_RUNNING means the stage has begun execution.

STAGE_STATUS_COMPLETED means the stage has ceased execution.

Success/failure of a stage cannot be inferred from this status

alone but rather this status plus the stage error. That is, no

error implies success and some error implies failure.

STAGE_STATUS_NOT_STARTED means the stage has not been started.

PartialEqFilter provides a way to server-side filter a DeleteAll.

This requires all provided fields to be equal to the response.

A filtered DeleteAll will use GetAll with filter to find things to delete.

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

This indicates the error message from the delete failure.

This is the key of the ApproveConfig instance that failed to be deleted.

Time indicates the (UTC) timestamp when the key was being deleted.

Key indicates which ApproveConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted ApproveConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

key contains a list of ApproveConfig keys to delete

Key uniquely identifies a ApproveConfig instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

ApproveConfig instance in this response.

ApproveConfig carries the value to set into the datastore.

See the documentation on the ApproveConfig struct for which fields are required.

Value carries all the values given in the ApproveConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

value contains a list of ApproveConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each ApproveConfig at end.

* Each ApproveConfig response is fully-specified (all fields set).

* start: Returns the state of each ApproveConfig at start, followed by updates until now.

* Each ApproveConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each ApproveConfig at start, followed by updates

until end.

* Each ApproveConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this ApproveConfig’s last modification.

Operation indicates how the ApproveConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

PartialEqFilter provides a way to server-side filter a DeleteAll.

This requires all provided fields to be equal to the response.

A filtered DeleteAll will use GetAll with filter to find things to delete.

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

This indicates the error message from the delete failure.

This is the key of the ChangeControlConfig instance that failed to be deleted.

Time indicates the (UTC) timestamp when the key was being deleted.

Key indicates which ChangeControlConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted ChangeControlConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

key contains a list of ChangeControlConfig keys to delete

Key uniquely identifies a ChangeControlConfig instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

ChangeControlConfig instance in this response.

ChangeControlConfig carries the value to set into the datastore.

See the documentation on the ChangeControlConfig struct for which fields are required.

Value carries all the values given in the ChangeControlConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

value contains a list of ChangeControlConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each ChangeControlConfig at end.

* Each ChangeControlConfig response is fully-specified (all fields set).

* start: Returns the state of each ChangeControlConfig at start, followed by updates until now.

* Each ChangeControlConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each ChangeControlConfig at start, followed by updates

until end.

* Each ChangeControlConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this ChangeControlConfig’s last modification.

Operation indicates how the ChangeControlConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Key uniquely identifies a ChangeControl instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

ChangeControl instance in this response.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

For each ChangeControl in the list, all populated fields are considered ANDed together

as a filtering operation. Similarly, the list itself is ORed such that any individual

filter that matches a given ChangeControl is streamed to the user.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each ChangeControl at end.

* Each ChangeControl response is fully-specified (all fields set).

* start: Returns the state of each ChangeControl at start, followed by updates until now.

* Each ChangeControl response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each ChangeControl at start, followed by updates

until end.

* Each ChangeControl response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this ChangeControl’s last modification.

Operation indicates how the ChangeControl value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Time holds the timestamp of the last item included in the metadata calculation.

Operation indicates how the value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Count is the number of items present under the conditions of the request.