redirector.v1

Version: 1.1.0

Available Services

    AssignmentService

• arista/redirector.v1/redirector.proto
  • Assignment
  • AssignmentKey
  • Cluster
  • Clusters
• arista/redirector.v1/services.gen.proto

  • AssignmentBatchedStreamRequest

  • AssignmentBatchedStreamResponse

  • AssignmentRequest

  • AssignmentResponse

  • AssignmentSomeRequest

  • AssignmentSomeResponse

  • AssignmentStreamRequest

  • AssignmentStreamResponse

  • MetaResponse

  • AssignmentService

Top

arista/redirector.v1/redirector.proto

Assignment

Assignment returns the information about the regional clusters that the system is assigned to. Each cluster consists of a series of hosts, each of which the client can use to connect.

Field Name	Type	Description
key	AssignmentKey	key uniquely identifies the assignment of system_id to the cluster.
clusters	Clusters	clusters that the system is assigned to.

AssignmentKey

AssignmentKey allows to uniquely identify an assignment.

Field Name	Type	Description
system_id	google.protobuf.StringValue	system_id is the unique identifier of a device.

Cluster

Field Name	Type	Description
name	google.protobuf.StringValue	name of the cluster. The name can change over time as new clusters are added or removed.
hosts	fmp.RepeatedString	hosts in the cluster that the devices can connect to.

Clusters

Clusters wraps a cluster list which contain the information about the hosts.

Field Name	Type	Description
values	Cluster[...]	values contains the list of clusters associated with the region

Top

arista/redirector.v1/services.gen.proto

AssignmentBatchedStreamRequest

Field Name	Type	Description
partial_eq_filter	Assignment[...]	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.
time	arista.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 Assignment at end. * Each Assignment response is fully-specified (all fields set). * start: Returns the state of each Assignment at start, followed by updates until now. * Each Assignment response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Assignment at start, followed by updates until end. * Each Assignment response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.
max_messages	google.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.

AssignmentBatchedStreamResponse

Field Name	Type	Description
responses	AssignmentStreamResponse[...]	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).

AssignmentRequest

Field Name	Type	Description
key	AssignmentKey	Key uniquely identifies a Assignment instance to retrieve. This value must be populated.
time	google.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.

AssignmentResponse

Field Name	Type	Description
value	Assignment	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
time	google.protobuf.Timestamp	Time carries the (UTC) timestamp of the last-modification of the Assignment instance in this response.

AssignmentSomeRequest

Field Name	Type	Description
keys	AssignmentKey[...]
time	google.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.

AssignmentSomeResponse

Field Name	Type	Description
value	Assignment	Value is the value requested. This structure will be fully-populated as it exists in the datastore. If optional fields were not given at creation, these fields will be empty or set to default values.
error	google.protobuf.StringValue	Error is an optional field. It should be filled when there is an error in the GetSome process.
time	google.protobuf.Timestamp

AssignmentStreamRequest

Field Name	Type	Description
partial_eq_filter	Assignment[...]	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.
time	arista.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 Assignment at end. * Each Assignment response is fully-specified (all fields set). * start: Returns the state of each Assignment at start, followed by updates until now. * Each Assignment response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each Assignment at start, followed by updates until end. * Each Assignment response at start is fully-specified, but updates until end may be partial. This field is not allowed in the Subscribe RPC.

AssignmentStreamResponse

Field Name	Type	Description
value	Assignment	Value is a value deemed relevant to the initiating request. This structure will always have its key-field populated. Which other fields are populated, and why, depends on the value of Operation and what triggered this notification.
time	google.protobuf.Timestamp	Time holds the timestamp of this Assignment's last modification.
type	arista.subscriptions.Operation	Operation indicates how the Assignment 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 Name	Type	Description
time	google.protobuf.Timestamp	Time holds the timestamp of the last item included in the metadata calculation.
type	arista.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.
count	google.protobuf.UInt32Value	Count is the number of items present under the conditions of the request.

AssignmentService

Method Name	Request Type	Response Type	Description
GetOne	AssignmentRequest	AssignmentResponse
GetSome	AssignmentSomeRequest	AssignmentSomeResponse stream
GetAll	AssignmentStreamRequest	AssignmentStreamResponse stream
Subscribe	AssignmentStreamRequest	AssignmentStreamResponse stream
GetMeta	AssignmentStreamRequest	MetaResponse
SubscribeMeta	AssignmentStreamRequest	MetaResponse stream
GetAllBatched	AssignmentBatchedStreamRequest	AssignmentBatchedStreamResponse stream
SubscribeBatched	AssignmentBatchedStreamRequest	AssignmentBatchedStreamResponse stream