Skip to main content
Version: trunk

studio_topology.v1

Version: 1.0.7

Available Services

    DecommissionConfigService

    DecommissionService

    DeviceInputConfigService

    DeviceStateService

    InterfaceInputConfigService

    ReplaceConfigService

    ReplaceService

    RevertConfigService

    UpdateConfigService

    UpdateService

    UpdateSyncConfigService

Top

arista/studio_topology.v1/studio_topology.proto

NOTE: This is a workspace-aware Resource API. Please see workspace.v1 for more information.

Decommission

Decommission is the resource that holds the decommissioning state of a device.

Field NameTypeDescription
keyDeviceKey

key uniquely identifies the device in a given workspace.

created_atgoogle.protobuf.Timestamp

created_at is the time at which decommissioning was first initiated.

created_bygoogle.protobuf.StringValue

created_by is the name of the user who first initiated decommissioning.

last_modified_atgoogle.protobuf.Timestamp

last_modified_at is the time at which the decommissioning was last modified.

last_modified_bygoogle.protobuf.StringValue

last_modified_by is the name of the user that last modified the status.

statusDecommissionStatus

status of the decommissioning operation

errorgoogle.protobuf.StringValue

error indicates if there is a failure in decommissioning

DecommissionConfig

DecommissionConfig is the resource for decommissioning the device from the studio.

Field NameTypeDescription
keyDeviceKey

key uniquely identifies the device for a given workspace.

DeviceInfo

DeviceInfo contains device properties.

Field NameTypeDescription
device_idgoogle.protobuf.StringValue

device_id identifies the device uniquely.

model_namegoogle.protobuf.StringValue

model_name indicates the model of the device.

mac_addressfmp.MACAddress

mac_address indicates the MAC address of the device.

hostnamegoogle.protobuf.StringValue

hostname indicates the hostname of the device.

DeviceInputConfig

DeviceInputConfig is the desired topology input for a device.

Field NameTypeDescription
keyDeviceKey

key uniquely identifies the device ID for a given workspace.

device_infoDeviceInfo

device_info contains device properties.

removegoogle.protobuf.BoolValue

remove if set to true will remove the device from mainline

post workspace merge

DeviceKey

DeviceKey uniquely identifies the device for a workspace.

Field NameTypeDescription
workspace_idgoogle.protobuf.StringValue

workspace_id identifies the workspace uniquely.

device_idgoogle.protobuf.StringValue

device_id identifies the device uniquely.

DeviceState

DeviceState is the state of a device written by InterfaceInputConfig, DeviceInputConfig and UpdateConfig resources

Field NameTypeDescription
keyDeviceKey

key uniquely identifies the device for a given workspace.

device_infoDeviceInfo

device_info contains device properties

interface_infosInterfaceInfos

interface_infos contains interface properties of all the interfaces

belonging to the device

InterfaceInfo

InterfaceInfo contains interface properties.

Field NameTypeDescription
namegoogle.protobuf.StringValue

name is the name of an interface.

neighbor_device_idgoogle.protobuf.StringValue

neighbor_device_id indicates the device ID of the neighbor to which

this interface is connected.

neighbor_interface_namegoogle.protobuf.StringValue

neighbor_interface_name indicates the interface on the neighbor to which

this interface is connected.

InterfaceInfos

InterfaceInfos is a list of InterfaceInfo.

Field NameTypeDescription
valuesInterfaceInfo[...]

values is a list of InterfaceInfo.

InterfaceInputConfig

InterfaceInputConfig is the resource for manually adding an interface in I&T studios

Field NameTypeDescription
keyInterfaceInputKey

key uniquely identifies the interface for a given workspace.

interface_infoInterfaceInfo

interface_info contains interface properties.

removegoogle.protobuf.BoolValue

remove if set to true will remove the interface from mainline

post workspace merge

InterfaceInputKey

InterfaceInputKey is the set of inputs that uniquely identify the interface for a workspace.

Field NameTypeDescription
workspace_idgoogle.protobuf.StringValue

workspace_id identifies the workspace uniquely.

device_idgoogle.protobuf.StringValue

device_id identifies the device uniquely.

interface_idgoogle.protobuf.StringValue

interface_id along with device_id identifies the interface uniquely.

Replace

Replace is the resource that holds the status of the replace operation.

Field NameTypeDescription
keyDeviceKey

key uniquely identifies the original device for a given workspace.

replacement_device_idgoogle.protobuf.StringValue

replacement_device_id is the device to replace the original device with.

created_atgoogle.protobuf.Timestamp

created_at is the time at which the status was first set.

created_bygoogle.protobuf.StringValue

created_by is the name of the user that first set the status.

last_modified_atgoogle.protobuf.Timestamp

last_modified_at is the time at which the status was last modified.

last_modified_bygoogle.protobuf.StringValue

last_modified_by is the name of the user that last modified the status.

statusReplaceStatus

status indicates the status of the replace operation.

errorgoogle.protobuf.StringValue

error provides the reason if there is a failure in replace.

ReplaceConfig

ReplaceConfig is the resource for replacing a device with another device in Studios.

Field NameTypeDescription
keyDeviceKey

key uniquely identifies the original device to be replaced in a given workspace.

replacement_device_idgoogle.protobuf.StringValue

replacement_device_id is the device to replace the original device with.

All references to the original device in Studios and tags will be replaced with this device.

RevertConfig

RevertConfig is the model provided to revert a workspace.

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

key uniquely identifies the workspace.

Update

Update represents an update on to the workspace.

Field NameTypeDescription
keyUpdateKey

key uniquely identifies the update.

elementElement

element indicates the type of a network element.

operationOperation

operation indicates the type of operation on the topology update.

statusUpdateStatus

status indicates the status of the topology update.

descriptiongoogle.protobuf.StringValue

description describes the topology update in short.

device_idgoogle.protobuf.StringValue

device_id indicates the device associated with the update.

UpdateConfig

UpdateConfig contains the acceptance status of an Update.

Field NameTypeDescription
keyUpdateKey

key uniquely identifies the update.

statusUpdateStatus

status indicates the status of the topology update.

removegoogle.protobuf.BoolValue

remove if set to true will remove the update key from mainline

post workspace merge. This can only be set true for ignored keys

since we don't carry accepted keys to mainline post workspace

merge

UpdateKey

UpdateKey uniquely identifies a workspace topology update.

Field NameTypeDescription
workspace_idgoogle.protobuf.StringValue

workspace_id identifies the workspace uniquely.

update_idgoogle.protobuf.StringValue

update_id identifies the update uniquely.

UpdateSyncConfig

UpdateSyncConfig model represents a point in time all updates are to be accepted.

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

key uniquely identifies the workspace.

sync_timegoogle.protobuf.Timestamp

sync_time indicates the desired synchronization time with the live topology.

If the sync_time indicated in the config takes effect without error,

it will appear in the state model, and then all updates that occurred up to

and including the timestamp in the state model will be accepted.

DecommissionStatus

DecommissionStatus enumerates the status of decommissioning a device.

NameNumberDescription
DECOMMISSION_STATUS_UNSPECIFIED0

DECOMMISSION_STATUS_UNSPECIFIED indicates that the device was decommissioned with

an unspecified state.

DECOMMISSION_STATUS_SUCCESS1

DECOMMISSION_STATUS_SUCCESS indicates that the device was successfully decommissioned.

DECOMMISSION_STATUS_FAILURE2

DECOMMISSION_STATUS_FAILURE indicates an error with decommissioning the device.

Element

Element defines the fundamental types of elements in topology.

NameNumberDescription
ELEMENT_UNSPECIFIED0

ELEMENT_UNSPECIFIED indicates an unspecified element type.

ELEMENT_DEVICE1

ELEMENT_DEVICE indicates a device.

ELEMENT_INTERFACE2

ELEMENT_INTERFACE indicates an interface.

ELEMENT_CONNECTION3

ELEMENT_CONNECTION indicates a connection.

Operation

Operation defines the operations that may be performed on the topology.

NameNumberDescription
OPERATION_UNSPECIFIED0

OPERATION_UNSPECIFIED indicates an unspecified operation.

OPERATION_ADDED1

OPERATION_ADDED indicates addition of an Element.

OPERATION_MODIFIED2

OPERATION_MODIFIED indicates modification of an Element.

OPERATION_REMOVED3

OPERATION_REMOVED indicates removal of an Element.

ReplaceStatus

ReplaceStatus enumerates the status of the device.

NameNumberDescription
REPLACE_STATUS_UNSPECIFIED0

REPLACE_STATUS_UNSPECIFIED indicates that the device was replaced with

an unspecified state.

REPLACE_STATUS_SUCCESS1

REPLACE_STATUS_SUCCESS indicates that the device was successfully replaced.

REPLACE_STATUS_FAILURE2

REPLACE_STATUS_FAILURE indicates an error with replace.

UpdateStatus

UpdateStatus defines the set of statuses that apply to individual topology updates.

NameNumberDescription
UPDATE_STATUS_UNSPECIFIED0

UPDATE_STATUS_UNSPECIFIED indicates an unspecified update status.

UPDATE_STATUS_NEW1

UPDATE_STATUS_NEW indicates the update is new.

UPDATE_STATUS_ACCEPTED2

UPDATE_STATUS_ACCEPTED indicates the update is accepted.

UPDATE_STATUS_IGNORED3

UPDATE_STATUS_IGNORED indicates the update is ignored.

Top

arista/studio_topology.v1/services.gen.proto

DecommissionBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterDecommission[...]

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.

timearista.time.TimeBounds

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 Decommission at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

DecommissionBatchedStreamResponse

Field NameTypeDescription
responsesDecommissionStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

DecommissionConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterDecommissionConfig[...]

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.

timearista.time.TimeBounds

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 DecommissionConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

DecommissionConfigBatchedStreamResponse

Field NameTypeDescription
responsesDecommissionConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

DecommissionConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterDecommissionConfig[...]

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.

DecommissionConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyDeviceKey

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

timegoogle.protobuf.Timestamp

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

DecommissionConfigDeleteRequest

Field NameTypeDescription
keyDeviceKey

Key indicates which DecommissionConfig instance to remove.

This field must always be set.

DecommissionConfigDeleteResponse

Field NameTypeDescription
keyDeviceKey

Key echoes back the key of the deleted DecommissionConfig instance.

timegoogle.protobuf.Timestamp

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.

DecommissionConfigDeleteSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

key contains a list of DecommissionConfig keys to delete

DecommissionConfigDeleteSomeResponse

DecommissionConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyDeviceKey

errorstring

DecommissionConfigRequest

Field NameTypeDescription
keyDeviceKey

Key uniquely identifies a DecommissionConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

DecommissionConfigResponse

Field NameTypeDescription
valueDecommissionConfig

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.

timegoogle.protobuf.Timestamp

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

DecommissionConfig instance in this response.

DecommissionConfigSetRequest

Field NameTypeDescription
valueDecommissionConfig

DecommissionConfig carries the value to set into the datastore.

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

DecommissionConfigSetResponse

Field NameTypeDescription
valueDecommissionConfig

Value carries all the values given in the DecommissionConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

DecommissionConfigSetSomeRequest

Field NameTypeDescription
valuesDecommissionConfig[...]

value contains a list of DecommissionConfig 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.

DecommissionConfigSetSomeResponse

Field NameTypeDescription
keyDeviceKey

errorstring

DecommissionConfigSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

timegoogle.protobuf.Timestamp

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.

DecommissionConfigSomeResponse

Field NameTypeDescription
valueDecommissionConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

DecommissionConfigStreamRequest

Field NameTypeDescription
partial_eq_filterDecommissionConfig[...]

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.

timearista.time.TimeBounds

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 DecommissionConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

DecommissionConfigStreamResponse

Field NameTypeDescription
valueDecommissionConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this DecommissionConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the DecommissionConfig 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.

DecommissionRequest

Field NameTypeDescription
keyDeviceKey

Key uniquely identifies a Decommission instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

DecommissionResponse

Field NameTypeDescription
valueDecommission

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.

timegoogle.protobuf.Timestamp

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

Decommission instance in this response.

DecommissionSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

timegoogle.protobuf.Timestamp

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.

DecommissionSomeResponse

Field NameTypeDescription
valueDecommission

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

DecommissionStreamRequest

Field NameTypeDescription
partial_eq_filterDecommission[...]

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.

timearista.time.TimeBounds

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 Decommission at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

DecommissionStreamResponse

Field NameTypeDescription
valueDecommission

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Decommission's last modification.

typearista.subscriptions.Operation

Operation indicates how the Decommission 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.

DeviceInputConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceInputConfig[...]

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.

timearista.time.TimeBounds

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 DeviceInputConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

DeviceInputConfigBatchedStreamResponse

Field NameTypeDescription
responsesDeviceInputConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

DeviceInputConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterDeviceInputConfig[...]

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.

DeviceInputConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyDeviceKey

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

timegoogle.protobuf.Timestamp

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

DeviceInputConfigDeleteRequest

Field NameTypeDescription
keyDeviceKey

Key indicates which DeviceInputConfig instance to remove.

This field must always be set.

DeviceInputConfigDeleteResponse

Field NameTypeDescription
keyDeviceKey

Key echoes back the key of the deleted DeviceInputConfig instance.

timegoogle.protobuf.Timestamp

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.

DeviceInputConfigDeleteSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

key contains a list of DeviceInputConfig keys to delete

DeviceInputConfigDeleteSomeResponse

DeviceInputConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyDeviceKey

errorstring

DeviceInputConfigRequest

Field NameTypeDescription
keyDeviceKey

Key uniquely identifies a DeviceInputConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

DeviceInputConfigResponse

Field NameTypeDescription
valueDeviceInputConfig

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.

timegoogle.protobuf.Timestamp

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

DeviceInputConfig instance in this response.

DeviceInputConfigSetRequest

Field NameTypeDescription
valueDeviceInputConfig

DeviceInputConfig carries the value to set into the datastore.

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

DeviceInputConfigSetResponse

Field NameTypeDescription
valueDeviceInputConfig

Value carries all the values given in the DeviceInputConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

DeviceInputConfigSetSomeRequest

Field NameTypeDescription
valuesDeviceInputConfig[...]

value contains a list of DeviceInputConfig 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.

DeviceInputConfigSetSomeResponse

Field NameTypeDescription
keyDeviceKey

errorstring

DeviceInputConfigSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

timegoogle.protobuf.Timestamp

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.

DeviceInputConfigSomeResponse

Field NameTypeDescription
valueDeviceInputConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

DeviceInputConfigStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceInputConfig[...]

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.

timearista.time.TimeBounds

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 DeviceInputConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

DeviceInputConfigStreamResponse

Field NameTypeDescription
valueDeviceInputConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this DeviceInputConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the DeviceInputConfig 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.

DeviceStateBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceState[...]

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.

timearista.time.TimeBounds

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 DeviceState at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

DeviceStateBatchedStreamResponse

Field NameTypeDescription
responsesDeviceStateStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

DeviceStateRequest

Field NameTypeDescription
keyDeviceKey

Key uniquely identifies a DeviceState instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

DeviceStateResponse

Field NameTypeDescription
valueDeviceState

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.

timegoogle.protobuf.Timestamp

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

DeviceState instance in this response.

DeviceStateSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

timegoogle.protobuf.Timestamp

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.

DeviceStateSomeResponse

Field NameTypeDescription
valueDeviceState

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

DeviceStateStreamRequest

Field NameTypeDescription
partial_eq_filterDeviceState[...]

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.

timearista.time.TimeBounds

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 DeviceState at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

DeviceStateStreamResponse

Field NameTypeDescription
valueDeviceState

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this DeviceState's last modification.

typearista.subscriptions.Operation

Operation indicates how the DeviceState 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.

InterfaceInputConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterInterfaceInputConfig[...]

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.

timearista.time.TimeBounds

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 InterfaceInputConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

InterfaceInputConfigBatchedStreamResponse

Field NameTypeDescription
responsesInterfaceInputConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

InterfaceInputConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterInterfaceInputConfig[...]

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.

InterfaceInputConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyInterfaceInputKey

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

timegoogle.protobuf.Timestamp

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

InterfaceInputConfigDeleteRequest

Field NameTypeDescription
keyInterfaceInputKey

Key indicates which InterfaceInputConfig instance to remove.

This field must always be set.

InterfaceInputConfigDeleteResponse

Field NameTypeDescription
keyInterfaceInputKey

Key echoes back the key of the deleted InterfaceInputConfig instance.

timegoogle.protobuf.Timestamp

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.

InterfaceInputConfigDeleteSomeRequest

Field NameTypeDescription
keysInterfaceInputKey[...]

key contains a list of InterfaceInputConfig keys to delete

InterfaceInputConfigDeleteSomeResponse

InterfaceInputConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyInterfaceInputKey

errorstring

InterfaceInputConfigRequest

Field NameTypeDescription
keyInterfaceInputKey

Key uniquely identifies a InterfaceInputConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

InterfaceInputConfigResponse

Field NameTypeDescription
valueInterfaceInputConfig

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.

timegoogle.protobuf.Timestamp

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

InterfaceInputConfig instance in this response.

InterfaceInputConfigSetRequest

Field NameTypeDescription
valueInterfaceInputConfig

InterfaceInputConfig carries the value to set into the datastore.

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

InterfaceInputConfigSetResponse

Field NameTypeDescription
valueInterfaceInputConfig

Value carries all the values given in the InterfaceInputConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

InterfaceInputConfigSetSomeRequest

Field NameTypeDescription
valuesInterfaceInputConfig[...]

value contains a list of InterfaceInputConfig 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.

InterfaceInputConfigSetSomeResponse

Field NameTypeDescription
keyInterfaceInputKey

errorstring

InterfaceInputConfigSomeRequest

Field NameTypeDescription
keysInterfaceInputKey[...]

timegoogle.protobuf.Timestamp

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.

InterfaceInputConfigSomeResponse

Field NameTypeDescription
valueInterfaceInputConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

InterfaceInputConfigStreamRequest

Field NameTypeDescription
partial_eq_filterInterfaceInputConfig[...]

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.

timearista.time.TimeBounds

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 InterfaceInputConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

InterfaceInputConfigStreamResponse

Field NameTypeDescription
valueInterfaceInputConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this InterfaceInputConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the InterfaceInputConfig 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.

MetaResponse

Field NameTypeDescription
timegoogle.protobuf.Timestamp

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

typearista.subscriptions.Operation

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.

countgoogle.protobuf.UInt32Value

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

ReplaceBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterReplace[...]

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.

timearista.time.TimeBounds

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 Replace at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

ReplaceBatchedStreamResponse

Field NameTypeDescription
responsesReplaceStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

ReplaceConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterReplaceConfig[...]

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.

timearista.time.TimeBounds

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 ReplaceConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

ReplaceConfigBatchedStreamResponse

Field NameTypeDescription
responsesReplaceConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

ReplaceConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterReplaceConfig[...]

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.

ReplaceConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyDeviceKey

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

timegoogle.protobuf.Timestamp

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

ReplaceConfigDeleteRequest

Field NameTypeDescription
keyDeviceKey

Key indicates which ReplaceConfig instance to remove.

This field must always be set.

ReplaceConfigDeleteResponse

Field NameTypeDescription
keyDeviceKey

Key echoes back the key of the deleted ReplaceConfig instance.

timegoogle.protobuf.Timestamp

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.

ReplaceConfigDeleteSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

key contains a list of ReplaceConfig keys to delete

ReplaceConfigDeleteSomeResponse

ReplaceConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyDeviceKey

errorstring

ReplaceConfigRequest

Field NameTypeDescription
keyDeviceKey

Key uniquely identifies a ReplaceConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

ReplaceConfigResponse

Field NameTypeDescription
valueReplaceConfig

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.

timegoogle.protobuf.Timestamp

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

ReplaceConfig instance in this response.

ReplaceConfigSetRequest

Field NameTypeDescription
valueReplaceConfig

ReplaceConfig carries the value to set into the datastore.

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

ReplaceConfigSetResponse

Field NameTypeDescription
valueReplaceConfig

Value carries all the values given in the ReplaceConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

ReplaceConfigSetSomeRequest

Field NameTypeDescription
valuesReplaceConfig[...]

value contains a list of ReplaceConfig 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.

ReplaceConfigSetSomeResponse

Field NameTypeDescription
keyDeviceKey

errorstring

ReplaceConfigSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

timegoogle.protobuf.Timestamp

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.

ReplaceConfigSomeResponse

Field NameTypeDescription
valueReplaceConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

ReplaceConfigStreamRequest

Field NameTypeDescription
partial_eq_filterReplaceConfig[...]

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.

timearista.time.TimeBounds

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 ReplaceConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

ReplaceConfigStreamResponse

Field NameTypeDescription
valueReplaceConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this ReplaceConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the ReplaceConfig 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.

ReplaceRequest

Field NameTypeDescription
keyDeviceKey

Key uniquely identifies a Replace instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

ReplaceResponse

Field NameTypeDescription
valueReplace

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.

timegoogle.protobuf.Timestamp

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

Replace instance in this response.

ReplaceSomeRequest

Field NameTypeDescription
keysDeviceKey[...]

timegoogle.protobuf.Timestamp

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.

ReplaceSomeResponse

Field NameTypeDescription
valueReplace

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

ReplaceStreamRequest

Field NameTypeDescription
partial_eq_filterReplace[...]

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.

timearista.time.TimeBounds

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 Replace at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

ReplaceStreamResponse

Field NameTypeDescription
valueReplace

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Replace's last modification.

typearista.subscriptions.Operation

Operation indicates how the Replace 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.

RevertConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterRevertConfig[...]

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.

timearista.time.TimeBounds

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 RevertConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

RevertConfigBatchedStreamResponse

Field NameTypeDescription
responsesRevertConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

RevertConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterRevertConfig[...]

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.

RevertConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyarista.workspace.v1.WorkspaceKey

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

timegoogle.protobuf.Timestamp

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

RevertConfigDeleteRequest

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

Key indicates which RevertConfig instance to remove.

This field must always be set.

RevertConfigDeleteResponse

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

Key echoes back the key of the deleted RevertConfig instance.

timegoogle.protobuf.Timestamp

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.

RevertConfigDeleteSomeRequest

Field NameTypeDescription
keysarista.workspace.v1.WorkspaceKey[...]

key contains a list of RevertConfig keys to delete

RevertConfigDeleteSomeResponse

RevertConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

errorstring

RevertConfigRequest

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

Key uniquely identifies a RevertConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

RevertConfigResponse

Field NameTypeDescription
valueRevertConfig

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.

timegoogle.protobuf.Timestamp

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

RevertConfig instance in this response.

RevertConfigSetRequest

Field NameTypeDescription
valueRevertConfig

RevertConfig carries the value to set into the datastore.

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

RevertConfigSetResponse

Field NameTypeDescription
valueRevertConfig

Value carries all the values given in the RevertConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

RevertConfigSetSomeRequest

Field NameTypeDescription
valuesRevertConfig[...]

value contains a list of RevertConfig 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.

RevertConfigSetSomeResponse

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

errorstring

RevertConfigSomeRequest

Field NameTypeDescription
keysarista.workspace.v1.WorkspaceKey[...]

timegoogle.protobuf.Timestamp

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.

RevertConfigSomeResponse

Field NameTypeDescription
valueRevertConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

RevertConfigStreamRequest

Field NameTypeDescription
partial_eq_filterRevertConfig[...]

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.

timearista.time.TimeBounds

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 RevertConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

RevertConfigStreamResponse

Field NameTypeDescription
valueRevertConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this RevertConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the RevertConfig 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.

UpdateBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterUpdate[...]

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.

timearista.time.TimeBounds

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 Update at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

UpdateBatchedStreamResponse

Field NameTypeDescription
responsesUpdateStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

UpdateConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterUpdateConfig[...]

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.

timearista.time.TimeBounds

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 UpdateConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

UpdateConfigBatchedStreamResponse

Field NameTypeDescription
responsesUpdateConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

UpdateConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterUpdateConfig[...]

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.

UpdateConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyUpdateKey

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

timegoogle.protobuf.Timestamp

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

UpdateConfigDeleteRequest

Field NameTypeDescription
keyUpdateKey

Key indicates which UpdateConfig instance to remove.

This field must always be set.

UpdateConfigDeleteResponse

Field NameTypeDescription
keyUpdateKey

Key echoes back the key of the deleted UpdateConfig instance.

timegoogle.protobuf.Timestamp

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.

UpdateConfigDeleteSomeRequest

Field NameTypeDescription
keysUpdateKey[...]

key contains a list of UpdateConfig keys to delete

UpdateConfigDeleteSomeResponse

UpdateConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyUpdateKey

errorstring

UpdateConfigRequest

Field NameTypeDescription
keyUpdateKey

Key uniquely identifies a UpdateConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

UpdateConfigResponse

Field NameTypeDescription
valueUpdateConfig

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.

timegoogle.protobuf.Timestamp

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

UpdateConfig instance in this response.

UpdateConfigSetRequest

Field NameTypeDescription
valueUpdateConfig

UpdateConfig carries the value to set into the datastore.

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

UpdateConfigSetResponse

Field NameTypeDescription
valueUpdateConfig

Value carries all the values given in the UpdateConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

UpdateConfigSetSomeRequest

Field NameTypeDescription
valuesUpdateConfig[...]

value contains a list of UpdateConfig 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.

UpdateConfigSetSomeResponse

Field NameTypeDescription
keyUpdateKey

errorstring

UpdateConfigSomeRequest

Field NameTypeDescription
keysUpdateKey[...]

timegoogle.protobuf.Timestamp

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.

UpdateConfigSomeResponse

Field NameTypeDescription
valueUpdateConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

UpdateConfigStreamRequest

Field NameTypeDescription
partial_eq_filterUpdateConfig[...]

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.

timearista.time.TimeBounds

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 UpdateConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

UpdateConfigStreamResponse

Field NameTypeDescription
valueUpdateConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this UpdateConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the UpdateConfig 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.

UpdateRequest

Field NameTypeDescription
keyUpdateKey

Key uniquely identifies a Update instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

UpdateResponse

Field NameTypeDescription
valueUpdate

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.

timegoogle.protobuf.Timestamp

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

Update instance in this response.

UpdateSomeRequest

Field NameTypeDescription
keysUpdateKey[...]

timegoogle.protobuf.Timestamp

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.

UpdateSomeResponse

Field NameTypeDescription
valueUpdate

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

UpdateStreamRequest

Field NameTypeDescription
partial_eq_filterUpdate[...]

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.

timearista.time.TimeBounds

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 Update at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

UpdateStreamResponse

Field NameTypeDescription
valueUpdate

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Update's last modification.

typearista.subscriptions.Operation

Operation indicates how the Update 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.

UpdateSyncConfigBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterUpdateSyncConfig[...]

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.

timearista.time.TimeBounds

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 UpdateSyncConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

max_messagesgoogle.protobuf.UInt32Value

MaxMessages limits the maximum number of messages that can be contained in one batch.

MaxMessages is required to be at least 1.

The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT)

INTERNAL_BATCH_LIMIT is set based on the maximum message size.

UpdateSyncConfigBatchedStreamResponse

Field NameTypeDescription
responsesUpdateSyncConfigStreamResponse[...]

Values are the values deemed relevant to the initiating request.

The length of this structure is guaranteed to be between (inclusive) 1 and

min(req.max_messages, INTERNAL_BATCH_LIMIT).

UpdateSyncConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterUpdateSyncConfig[...]

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.

UpdateSyncConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyarista.workspace.v1.WorkspaceKey

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

timegoogle.protobuf.Timestamp

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

UpdateSyncConfigDeleteRequest

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

Key indicates which UpdateSyncConfig instance to remove.

This field must always be set.

UpdateSyncConfigDeleteResponse

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

Key echoes back the key of the deleted UpdateSyncConfig instance.

timegoogle.protobuf.Timestamp

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.

UpdateSyncConfigDeleteSomeRequest

Field NameTypeDescription
keysarista.workspace.v1.WorkspaceKey[...]

key contains a list of UpdateSyncConfig keys to delete

UpdateSyncConfigDeleteSomeResponse

UpdateSyncConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

errorstring

UpdateSyncConfigRequest

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

Key uniquely identifies a UpdateSyncConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

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.

UpdateSyncConfigResponse

Field NameTypeDescription
valueUpdateSyncConfig

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.

timegoogle.protobuf.Timestamp

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

UpdateSyncConfig instance in this response.

UpdateSyncConfigSetRequest

Field NameTypeDescription
valueUpdateSyncConfig

UpdateSyncConfig carries the value to set into the datastore.

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

UpdateSyncConfigSetResponse

Field NameTypeDescription
valueUpdateSyncConfig

Value carries all the values given in the UpdateSyncConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

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.

UpdateSyncConfigSetSomeRequest

Field NameTypeDescription
valuesUpdateSyncConfig[...]

value contains a list of UpdateSyncConfig 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.

UpdateSyncConfigSetSomeResponse

Field NameTypeDescription
keyarista.workspace.v1.WorkspaceKey

errorstring

UpdateSyncConfigSomeRequest

Field NameTypeDescription
keysarista.workspace.v1.WorkspaceKey[...]

timegoogle.protobuf.Timestamp

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.

UpdateSyncConfigSomeResponse

Field NameTypeDescription
valueUpdateSyncConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

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

timegoogle.protobuf.Timestamp

UpdateSyncConfigStreamRequest

Field NameTypeDescription
partial_eq_filterUpdateSyncConfig[...]

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.

timearista.time.TimeBounds

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 UpdateSyncConfig at end.

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

UpdateSyncConfigStreamResponse

Field NameTypeDescription
valueUpdateSyncConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this UpdateSyncConfig's last modification.

typearista.subscriptions.Operation

Operation indicates how the UpdateSyncConfig 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.

DecommissionConfigService

Method NameRequest TypeResponse TypeDescription
GetOneDecommissionConfigRequestDecommissionConfigResponse

GetSomeDecommissionConfigSomeRequestDecommissionConfigSomeResponse stream

GetAllDecommissionConfigStreamRequestDecommissionConfigStreamResponse stream

SubscribeDecommissionConfigStreamRequestDecommissionConfigStreamResponse stream

GetMetaDecommissionConfigStreamRequestMetaResponse

SubscribeMetaDecommissionConfigStreamRequestMetaResponse stream

SetDecommissionConfigSetRequestDecommissionConfigSetResponse

SetSomeDecommissionConfigSetSomeRequestDecommissionConfigSetSomeResponse stream

DeleteDecommissionConfigDeleteRequestDecommissionConfigDeleteResponse

DeleteSomeDecommissionConfigDeleteSomeRequestDecommissionConfigDeleteSomeResponse stream

DeleteAllDecommissionConfigDeleteAllRequestDecommissionConfigDeleteAllResponse stream

GetAllBatchedDecommissionConfigBatchedStreamRequestDecommissionConfigBatchedStreamResponse stream

SubscribeBatchedDecommissionConfigBatchedStreamRequestDecommissionConfigBatchedStreamResponse stream

DecommissionService

Method NameRequest TypeResponse TypeDescription
GetOneDecommissionRequestDecommissionResponse

GetSomeDecommissionSomeRequestDecommissionSomeResponse stream

GetAllDecommissionStreamRequestDecommissionStreamResponse stream

SubscribeDecommissionStreamRequestDecommissionStreamResponse stream

GetMetaDecommissionStreamRequestMetaResponse

SubscribeMetaDecommissionStreamRequestMetaResponse stream

GetAllBatchedDecommissionBatchedStreamRequestDecommissionBatchedStreamResponse stream

SubscribeBatchedDecommissionBatchedStreamRequestDecommissionBatchedStreamResponse stream

DeviceInputConfigService

Method NameRequest TypeResponse TypeDescription
GetOneDeviceInputConfigRequestDeviceInputConfigResponse

GetSomeDeviceInputConfigSomeRequestDeviceInputConfigSomeResponse stream

GetAllDeviceInputConfigStreamRequestDeviceInputConfigStreamResponse stream

SubscribeDeviceInputConfigStreamRequestDeviceInputConfigStreamResponse stream

GetMetaDeviceInputConfigStreamRequestMetaResponse

SubscribeMetaDeviceInputConfigStreamRequestMetaResponse stream

SetDeviceInputConfigSetRequestDeviceInputConfigSetResponse

SetSomeDeviceInputConfigSetSomeRequestDeviceInputConfigSetSomeResponse stream

DeleteDeviceInputConfigDeleteRequestDeviceInputConfigDeleteResponse

DeleteSomeDeviceInputConfigDeleteSomeRequestDeviceInputConfigDeleteSomeResponse stream

DeleteAllDeviceInputConfigDeleteAllRequestDeviceInputConfigDeleteAllResponse stream

GetAllBatchedDeviceInputConfigBatchedStreamRequestDeviceInputConfigBatchedStreamResponse stream

SubscribeBatchedDeviceInputConfigBatchedStreamRequestDeviceInputConfigBatchedStreamResponse stream

DeviceStateService

Method NameRequest TypeResponse TypeDescription
GetOneDeviceStateRequestDeviceStateResponse

GetSomeDeviceStateSomeRequestDeviceStateSomeResponse stream

GetAllDeviceStateStreamRequestDeviceStateStreamResponse stream

SubscribeDeviceStateStreamRequestDeviceStateStreamResponse stream

GetMetaDeviceStateStreamRequestMetaResponse

SubscribeMetaDeviceStateStreamRequestMetaResponse stream

GetAllBatchedDeviceStateBatchedStreamRequestDeviceStateBatchedStreamResponse stream

SubscribeBatchedDeviceStateBatchedStreamRequestDeviceStateBatchedStreamResponse stream

InterfaceInputConfigService

Method NameRequest TypeResponse TypeDescription
GetOneInterfaceInputConfigRequestInterfaceInputConfigResponse

GetSomeInterfaceInputConfigSomeRequestInterfaceInputConfigSomeResponse stream

GetAllInterfaceInputConfigStreamRequestInterfaceInputConfigStreamResponse stream

SubscribeInterfaceInputConfigStreamRequestInterfaceInputConfigStreamResponse stream

GetMetaInterfaceInputConfigStreamRequestMetaResponse

SubscribeMetaInterfaceInputConfigStreamRequestMetaResponse stream

SetInterfaceInputConfigSetRequestInterfaceInputConfigSetResponse

SetSomeInterfaceInputConfigSetSomeRequestInterfaceInputConfigSetSomeResponse stream

DeleteInterfaceInputConfigDeleteRequestInterfaceInputConfigDeleteResponse

DeleteSomeInterfaceInputConfigDeleteSomeRequestInterfaceInputConfigDeleteSomeResponse stream

DeleteAllInterfaceInputConfigDeleteAllRequestInterfaceInputConfigDeleteAllResponse stream

GetAllBatchedInterfaceInputConfigBatchedStreamRequestInterfaceInputConfigBatchedStreamResponse stream

SubscribeBatchedInterfaceInputConfigBatchedStreamRequestInterfaceInputConfigBatchedStreamResponse stream

ReplaceConfigService

Method NameRequest TypeResponse TypeDescription
GetOneReplaceConfigRequestReplaceConfigResponse

GetSomeReplaceConfigSomeRequestReplaceConfigSomeResponse stream

GetAllReplaceConfigStreamRequestReplaceConfigStreamResponse stream

SubscribeReplaceConfigStreamRequestReplaceConfigStreamResponse stream

GetMetaReplaceConfigStreamRequestMetaResponse

SubscribeMetaReplaceConfigStreamRequestMetaResponse stream

SetReplaceConfigSetRequestReplaceConfigSetResponse

SetSomeReplaceConfigSetSomeRequestReplaceConfigSetSomeResponse stream

DeleteReplaceConfigDeleteRequestReplaceConfigDeleteResponse

DeleteSomeReplaceConfigDeleteSomeRequestReplaceConfigDeleteSomeResponse stream

DeleteAllReplaceConfigDeleteAllRequestReplaceConfigDeleteAllResponse stream

GetAllBatchedReplaceConfigBatchedStreamRequestReplaceConfigBatchedStreamResponse stream

SubscribeBatchedReplaceConfigBatchedStreamRequestReplaceConfigBatchedStreamResponse stream

ReplaceService

Method NameRequest TypeResponse TypeDescription
GetOneReplaceRequestReplaceResponse

GetSomeReplaceSomeRequestReplaceSomeResponse stream

GetAllReplaceStreamRequestReplaceStreamResponse stream

SubscribeReplaceStreamRequestReplaceStreamResponse stream

GetMetaReplaceStreamRequestMetaResponse

SubscribeMetaReplaceStreamRequestMetaResponse stream

GetAllBatchedReplaceBatchedStreamRequestReplaceBatchedStreamResponse stream

SubscribeBatchedReplaceBatchedStreamRequestReplaceBatchedStreamResponse stream

RevertConfigService

Method NameRequest TypeResponse TypeDescription
GetOneRevertConfigRequestRevertConfigResponse

GetSomeRevertConfigSomeRequestRevertConfigSomeResponse stream

GetAllRevertConfigStreamRequestRevertConfigStreamResponse stream

SubscribeRevertConfigStreamRequestRevertConfigStreamResponse stream

GetMetaRevertConfigStreamRequestMetaResponse

SubscribeMetaRevertConfigStreamRequestMetaResponse stream

SetRevertConfigSetRequestRevertConfigSetResponse

SetSomeRevertConfigSetSomeRequestRevertConfigSetSomeResponse stream

DeleteRevertConfigDeleteRequestRevertConfigDeleteResponse

DeleteSomeRevertConfigDeleteSomeRequestRevertConfigDeleteSomeResponse stream

DeleteAllRevertConfigDeleteAllRequestRevertConfigDeleteAllResponse stream

GetAllBatchedRevertConfigBatchedStreamRequestRevertConfigBatchedStreamResponse stream

SubscribeBatchedRevertConfigBatchedStreamRequestRevertConfigBatchedStreamResponse stream

UpdateConfigService

Method NameRequest TypeResponse TypeDescription
GetOneUpdateConfigRequestUpdateConfigResponse

GetSomeUpdateConfigSomeRequestUpdateConfigSomeResponse stream

GetAllUpdateConfigStreamRequestUpdateConfigStreamResponse stream

SubscribeUpdateConfigStreamRequestUpdateConfigStreamResponse stream

GetMetaUpdateConfigStreamRequestMetaResponse

SubscribeMetaUpdateConfigStreamRequestMetaResponse stream

SetUpdateConfigSetRequestUpdateConfigSetResponse

SetSomeUpdateConfigSetSomeRequestUpdateConfigSetSomeResponse stream

DeleteUpdateConfigDeleteRequestUpdateConfigDeleteResponse

DeleteSomeUpdateConfigDeleteSomeRequestUpdateConfigDeleteSomeResponse stream

DeleteAllUpdateConfigDeleteAllRequestUpdateConfigDeleteAllResponse stream

GetAllBatchedUpdateConfigBatchedStreamRequestUpdateConfigBatchedStreamResponse stream

SubscribeBatchedUpdateConfigBatchedStreamRequestUpdateConfigBatchedStreamResponse stream

UpdateService

Method NameRequest TypeResponse TypeDescription
GetOneUpdateRequestUpdateResponse

GetSomeUpdateSomeRequestUpdateSomeResponse stream

GetAllUpdateStreamRequestUpdateStreamResponse stream

SubscribeUpdateStreamRequestUpdateStreamResponse stream

GetMetaUpdateStreamRequestMetaResponse

SubscribeMetaUpdateStreamRequestMetaResponse stream

GetAllBatchedUpdateBatchedStreamRequestUpdateBatchedStreamResponse stream

SubscribeBatchedUpdateBatchedStreamRequestUpdateBatchedStreamResponse stream

UpdateSyncConfigService

Method NameRequest TypeResponse TypeDescription
GetOneUpdateSyncConfigRequestUpdateSyncConfigResponse

GetSomeUpdateSyncConfigSomeRequestUpdateSyncConfigSomeResponse stream

GetAllUpdateSyncConfigStreamRequestUpdateSyncConfigStreamResponse stream

SubscribeUpdateSyncConfigStreamRequestUpdateSyncConfigStreamResponse stream

GetMetaUpdateSyncConfigStreamRequestMetaResponse

SubscribeMetaUpdateSyncConfigStreamRequestMetaResponse stream

SetUpdateSyncConfigSetRequestUpdateSyncConfigSetResponse

SetSomeUpdateSyncConfigSetSomeRequestUpdateSyncConfigSetSomeResponse stream

DeleteUpdateSyncConfigDeleteRequestUpdateSyncConfigDeleteResponse

DeleteSomeUpdateSyncConfigDeleteSomeRequestUpdateSyncConfigDeleteSomeResponse stream

DeleteAllUpdateSyncConfigDeleteAllRequestUpdateSyncConfigDeleteAllResponse stream

GetAllBatchedUpdateSyncConfigBatchedStreamRequestUpdateSyncConfigBatchedStreamResponse stream

SubscribeBatchedUpdateSyncConfigBatchedStreamRequestUpdateSyncConfigBatchedStreamResponse stream