studio.v1

Top

arista/studio.v1/studio.proto

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

AssignedTags

AssignedTags can be used to retrieve additional metadata about a studio’s AssignedTagsConfig.

Field NameTypeDescription
keyStudioKey

key uniquely identifies the studio to which devices were assigned.

created_atgoogle.protobuf.Timestamp

created_at is the time at which the assignment was first created.

created_bygoogle.protobuf.StringValue

created_by is the name of the user that created the assignment.

last_modified_atgoogle.protobuf.Timestamp

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

last_modified_bygoogle.protobuf.StringValue

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

querygoogle.protobuf.StringValue

query is a tag query string that conforms to the CloudVision

tag query language. See AssignedTagsConfig.

AssignedTagsConfig

AssignedTagsConfig holds a configuration to assign a studio to a set of devices matching a tag query.

Field NameTypeDescription
keyStudioKey

key uniquely identifies the studio to which to assign devices.

removegoogle.protobuf.BoolValue

remove indicates whether to remove (true) or add (false,

unset) the tag assignments involving the studio identified

by the key if the encompassing workspace merges. Other data

fields are not allowed if this field is set to true.

querygoogle.protobuf.StringValue

query is a tag query string that conforms to the CloudVision

tag query language. E.g., the query, "datacenter:NYC,SFO AND</p><p>sflow:enabled", matches all devices with sflow enabled in

data centers NYC and SFO.

AutofillAction

AutofillAction can be used to retrieve additional metadata about an autofill action.

Field NameTypeDescription
keyAutofillActionKey

key uniquely identifies the action-to-studio association.

created_atgoogle.protobuf.Timestamp

created_at is the time at which the inputs were first set.

created_bygoogle.protobuf.StringValue

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

last_modified_atgoogle.protobuf.Timestamp

last_modified_at is the time at which the inputs were last modified.

last_modified_bygoogle.protobuf.StringValue

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

action_idgoogle.protobuf.StringValue

action_id uniquely identifies the autofill action associated with the input field.

descriptiongoogle.protobuf.StringValue

description is an optional field to describe the autofill action that will be

displayed in a tooltip in the UI when the user hovers over the button to run

the autofill action.

argument_providersAutofillArgumentProviders

argument_providers is an optional field that specifies how dynamic arguments are

to be provided to the autofill action when executed. If an argument is omitted

from the provider map, it will not be defined in the arguments passed to the scripts.

If the entire field is omitted, no additional argument values will be passed to the

script beyond any statically defined arguments and the system-provided arguments

which are always set in an autofill action execution context (namely InputPath,

StudioID, and WorkspaceID).

AutofillActionConfig

AutofillActionConfig contains configuration information for an autofill action.

Field NameTypeDescription
keyAutofillActionKey

key uniquely identifies the action-to-studio association.

removegoogle.protobuf.BoolValue

remove indicates whether to remove (true) or add (false, unset)

the autofill action configuration identified by the key if the encompassing

workspace merges. Other data fields are not allowed if this field is set to true.

action_idgoogle.protobuf.StringValue

action_id uniquely identifies the autofill action associated with the input field.

descriptiongoogle.protobuf.StringValue

description is an optional field to describe the autofill action that will be

displayed in a tooltip in the UI when the user hovers over the button to run

the autofill action.

argument_providersAutofillArgumentProviders

argument_providers is an optional field that specifies how dynamic arguments are

to be provided to the autofill action when executed. If an argument is omitted

from the provider map, it will not be defined in the arguments passed to the scripts.

If the entire field is omitted, no additional argument values will be passed to the

script beyond any statically defined arguments and the system-provided arguments

which are always set in an autofill action execution context (namely InputPath,

StudioId, and WorkspaceId).

AutofillActionKey

AutofillActionKey identifies an autofill action.

Field NameTypeDescription
studio_idgoogle.protobuf.StringValue

studio_id uniquely identifies the studio in the workspace indicated

by workspace_id.

workspace_idgoogle.protobuf.StringValue

workspace_id uniquely identifies the workspace in which the studio resides.

input_field_idgoogle.protobuf.StringValue

input_field_id uniquely identifies the input field within the schema associated

with the action indicated by action_id.

AutofillArgumentProvider

AutofillArgumentProvider describes a particular dynamic argument’s type and value (if applicable).

Field NameTypeDescription
typeAutofillProviderType

type is the type of argument provider, describing how it is to be

handled when the associated action is called.

valuegoogle.protobuf.StringValue

value is the value of the argument, if provided.

When the provider type is PROVIDER_TYPE_USER_SPECIFIED, the field may be nil. If non-nil,

the field contains a default value for the user input.

When the provider type is PROVIDER_TYPE_PREDEFINED, the field contains the predefined

value.

When the provider type is PROVIDER_TYPE_LINKED, the field contains the linked input

field’s ID.

AutofillArgumentProviders

AutofillArgumentProviders is a map of dynamic argument name to argument provider information.

Field NameTypeDescription
valuesAutofillArgumentProviders.ValuesEntry[…]

values is a map of dynamic argument name to argument provider information.

AutofillArgumentProviders.ValuesEntry

Field NameTypeDescription
keystring

valueAutofillArgumentProvider

BooleanInputFieldProps

BooleanInputFieldProps defines the set of properties for a single boolean field in a studio input schema.

Field NameTypeDescription
default_valuegoogle.protobuf.BoolValue

default_value is the default value of the boolean.

CollectionInputFieldProps

CollectionInputFieldProps defines the set of properties for a single collection field in a studio input schema.

Field NameTypeDescription
base_field_idgoogle.protobuf.StringValue

base_field_id (required) identifies the field in the schema

that should be used as the type for each element in the

collection.

keygoogle.protobuf.StringValue

key can be used when base_field_id references a group field,

and it identifies the field in that group that should be used

as the key for each element in the collection. This is used

for display purposes only.

Entities

Entities is a list of Entity.

Field NameTypeDescription
valuesEntities.ValuesEntry[…]

values is a map from entity type name to entity

The possible keys to this map are ENTITY_TYPE_STUDIO,

ENTITY_TYPE_INPUTS, ENTITY_TYPE_ASSIGNED_TAGS,

ENTITY_TYPE_BUILD_HOOK and ENTITY_TYPE_AUTOFILL_ACTION.

Entities.ValuesEntry

Field NameTypeDescription
keystring

valueEntity

Entity

Entity holds the basic information of an entity.

Field NameTypeDescription
entity_typeEntityType

EntityType is the type of the entity.

last_modified_atgoogle.protobuf.Timestamp

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

last_modified_bygoogle.protobuf.StringValue

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

removedgoogle.protobuf.BoolValue

removed indicates if the entity is removed.

FloatInputFieldProps

FloatInputFieldProps defines the set of properties for a single float field in a studio input schema.

Field NameTypeDescription
default_valuegoogle.protobuf.FloatValue

default_value is the default value of the float.

static_optionsfmp.RepeatedFloat

static_options defines the set of possible values for the float.

dynamic_optionsfmp.RepeatedString

dynamic_options defines the set of possible values for the float

based on the possible values for other floats in the schema.

Each field should be referenced by a JSON object of the form

{ "fieldId": <field_id> }.

E.g,

</p><p>[</p><p>{ "fieldId": "floatField1ID" },</p><p>{ "fieldId": "floatField2ID" }</p><p>]</p><p>

Here, the possible values for the floats identified by

"floatField1ID" and "floatField2ID" are used as the

possible values for this float.

extra_values_allowedgoogle.protobuf.BoolValue

extra_values_allowed allows adding values to the field in

addition to what’s allowed by static_options/dynamic_options.

GroupInputFieldProps

GroupInputFieldProps defines the set of properties for a single group field in a studio input schema.

Field NameTypeDescription
membersfmp.RepeatedString

members (required) identifies the member fields of the group

as defined in the schema.

InputField

InputField defines the set of properties for a single field in a studio input schema.

Field NameTypeDescription
idgoogle.protobuf.StringValue

id (required) uniquely identifies the field within the schema.

typeInputFieldType

type (required) specifies the type for the field.

namegoogle.protobuf.StringValue

name (required) is the variable name by which the field can be

referenced in the template for the studio.

labelgoogle.protobuf.StringValue

label (required) is the label of the field as displayed on the UI.

descriptiongoogle.protobuf.StringValue

description is a short description of the field.

requiredgoogle.protobuf.BoolValue

required indicates whether the field always requires a value. This

is false by default.

boolean_propsBooleanInputFieldProps

boolean_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_BOOLEAN.

integer_propsIntegerInputFieldProps

integer_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_INTEGER.

float_propsFloatInputFieldProps

float_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_FLOAT.

string_propsStringInputFieldProps

string_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_STRING.

group_propsGroupInputFieldProps

group_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_GROUP.

collection_propsCollectionInputFieldProps

collection_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_COLLECTION.

resolver_propsResolverInputFieldProps

resolver_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_RESOLVER.

auto_fill_action_idgoogle.protobuf.StringValue

auto_fill_action_id identifies the autofill action that can be

used to automatically populate the value of this field on the

UI.

tag_matcher_propsTagMatcherInputFieldProps

tag_matcher_props defines properties for the field if it is of type

INPUT_FIELD_TYPE_TAG_MATCHER.

InputFields

InputFields is a collection of InputField.

Field NameTypeDescription
valuesInputFields.ValuesEntry[…]

values (required) is a map from input field ID to InputField.

InputFields.ValuesEntry

Field NameTypeDescription
keystring

valueInputField

InputSchema

InputSchema defines an input schema for a studio, which determines the values that can be input into the studio.

Field NameTypeDescription
fieldsInputFields

fields (required) are the set of fields that make up the schema.

layoutLayout

layout (UI only) defines the display properties for fields.

Inputs

Inputs is used to retrieve the existing inputs to a studio.

Field NameTypeDescription
keyInputsKey

key uniquely identifies the set of inputs for the studio (at some path).

created_atgoogle.protobuf.Timestamp

created_at is the time at which the inputs were first set.

created_bygoogle.protobuf.StringValue

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

last_modified_atgoogle.protobuf.Timestamp

last_modified_at is the time at which the inputs were last modified.

last_modified_bygoogle.protobuf.StringValue

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

inputsgoogle.protobuf.StringValue

inputs is the value of the input field at the path as a JSON string.

NOTE: For GetAll and Subscribe, if the JSON is too large, it will

be split across multiple messages such that each is less than the Resource

API message size limit (1MB).

InputsConfig

InputsConfig is used to input values into a studio.

NOTE: Setting an input at a higher path overwrite any prior Sets at lower paths. E.g.,

  1. Set ["A", "X"] to "foo"
  2. Set ["A", "Y"] to "bar"
  3. Set ["A"] to {"X": "bar"}

The resulting inputs would be:

{ "A": { "X": "bar" } }
Field NameTypeDescription
keyInputsKey

key uniquely identifies the set of inputs for the studio (at some path).

removegoogle.protobuf.BoolValue

remove indicates whether to remove (true) or add (false,

unset) the inputs identified by the key if the encompassing

workspace merges. Other data fields are not allowed if this

field is set to true.

inputsgoogle.protobuf.StringValue

inputs is the value of the input field at the path as a

JSON string. It can be the value for a simple or complex

input field.

Simple types (booleans, integers, floats, strings) map to

their JSON equivalents.

Complex types map to either arrays or objects:

* The group field type maps to a JSON object, where keys

are group members.

* The collection field type maps to a JSON array.

* The resolver field type maps to a JSON array, where each

element is an object of the form:

</p><p>{</p><p>"tags": { "query": <query> },</p><p>"inputs": <input></p><p>}</p><p>

Above, <input> is the value of the base field of the resolver.

E.g., if the base field is a group with one string member "A",

the resolver inputs would be specified as:

</p><p>"inputs": { "A": <value> }</p><p>

InputsKey

InputsKey identifies a set of inputs for a particular studio.

Field NameTypeDescription
studio_idgoogle.protobuf.StringValue

studio_id uniquely identifies the studio in the workspace indicated

by workspace_id.

workspace_idgoogle.protobuf.StringValue

workspace_id uniquely identifies the workspace in which the studio resides.

pathfmp.RepeatedString

path is the sequence of elements that uniquely identify an input field.

An empty path ([]) stands for the root of the inputs, or the entire

set of inputs for the studio.

The members of a group are referenced by field name. E.g., for a group

A with a member B, the path to B would be ["A", "B"].

The members of a collection or resolver are referenced by an integer

string. E.g., for a collection A with three members, the path to the

second member would be ["A", "1"].

IntegerInputFieldProps

IntegerInputFieldProps defines the set of properties for a single integer field in a studio input schema.

Field NameTypeDescription
default_valuegoogle.protobuf.Int64Value

default_value is the default value of the integer.

static_optionsfmp.RepeatedInt64

static_options defines the set of possible values for the integer.

rangegoogle.protobuf.StringValue

range imposes a range (inclusive) on the value of the integer.

This should be of the form "<min>..<max>". E.g., "-10..10"

means the integer can be anything in between and including -10

and 10.

dynamic_optionsfmp.RepeatedString

dynamic_options defines the set of possible values for the integer

based on the possible values for other integers in the schema.

Each field should be referenced by a JSON object of the form

{ "fieldId": <field_id> }.

E.g,

</p><p>[</p><p>{ "fieldId": "vlanFieldID" },</p><p>{ "fieldId": "vniFieldID" }</p><p>]</p><p>

Here, the possible values for the integers identified by

"vlanFieldID" and "vniFieldID" are used as the possible

values for this integer.

extra_values_allowedgoogle.protobuf.BoolValue

extra_values_allowed allows adding values to the field in

addition to what’s allowed by static_options/dynamic_options.

Layout

Layout specifies the display properties for input fields. This is intended for UI usage only.

Field NameTypeDescription
valuegoogle.protobuf.StringValue

value is a JSON object containing the layout config.

ResolverInputFieldProps

ResolverInputFieldProps defines the set of properties for a single resolver field in a studio input schema.

Field NameTypeDescription
base_field_idgoogle.protobuf.StringValue

base_field_id (required) identifies the field in the schema

to which the resolver query maps.

display_modeResolverFieldDisplayMode

display_mode (required) is the display mode of the resolver.

input_modeResolverFieldInputMode

input_mode (required) is the input mode of the resolver.

input_tag_labelgoogle.protobuf.StringValue

input_tag_label can be used when input_mode is one of

RESOLVER_FIELD_INPUT_MODE_SINGLE_*_TAG and it specifies

the tag label must be used in the resolver query.

tag_filter_querygoogle.protobuf.StringValue

tag_filter_query limits the set of elements that the

resolver query can return. E.g., "device:D1,D2" will

constrain results to the devices D1 and D2.

SecretInput

SecretInput can be used to retrieve the unmasked value of a secret in a studio.

Field NameTypeDescription
keyInputsKey

key identifies the secret in the studio inputs.

plain_textgoogle.protobuf.StringValue

plain_text is the unmasked value of the secret.

StringInputFieldProps

StringInputFieldProps defines the set of properties for a single string field in a studio input schema.

Field NameTypeDescription
default_valuegoogle.protobuf.StringValue

default_value is the default value of the string.

static_optionsfmp.RepeatedString

static_options defines the set of possible values for the string.

dynamic_optionsfmp.RepeatedString

dynamic_options defines the set of possible values for the string

based on the possible values for other strings in the schema.

Each field should be referenced by a JSON object of the form

{ "fieldId": <field_id> }.

E.g,

</p><p>[</p><p>{ "fieldId": "deviceFieldID" },</p><p>{ "fieldId": "ipFieldID" }</p><p>]</p><p>

Here, the possible values for the strings identified by

"deviceFieldID" and "ipFieldID" are used as the possible

values for this string.

lengthgoogle.protobuf.StringValue

length imposes a length range (inclusive) on the value of the

string. The should be of the form "<min>..<max>". E.g.,

"3..7" means the value of the string can be three to seven

characters long.

patterngoogle.protobuf.StringValue

pattern imposes a regular expression matching constraint on

the value of the string. This should be a Google RE2-compliant

regular expression (https://github.com/google/re2/wiki/Syntax).

formatgoogle.protobuf.StringValue

format imposes a well-known format on the value of the string.

The supported formats are:

* "ip": an IPv4 or IPv6 address

* "ipv4": an IPv4 address

* "ipv6": an IPv6 address

* "mac": a MAC address

* "cidr": an IPv4 or IPv6 address in CIDR notation (e.g. 10.1.1.1/24, 2001:db8:a0b::1/32)

* "cidrv4": an IPv4 address in CIDR notation (e.g. 10.1.1.1/24)

* "cidrv6": an IPv6 address in CIDR notation (e.g. 2001:db8:a0b::1/32)

* "url": a URL (e.g., http://www.google.com)

is_secretgoogle.protobuf.BoolValue

is_secret specifies whether the string is a secret and its

value should be masked. E.g., if this is set to true and

the value of the string is "secret-value-1", it will be

masked as "**********".

extra_values_allowedgoogle.protobuf.BoolValue

extra_values_allowed allows adding values to the field in

addition to what’s allowed by static_options/dynamic_options.

Studio

Studio holds the active state for a studio.

Field NameTypeDescription
keyStudioKey

key uniquely identifies the studio.

created_atgoogle.protobuf.Timestamp

created_at is the time at which the studio was created.

created_bygoogle.protobuf.StringValue

created_by is the name of the user that created the studio.

last_modified_atgoogle.protobuf.Timestamp

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

last_modified_bygoogle.protobuf.StringValue

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

display_namegoogle.protobuf.StringValue

display_name is the name of this studio as displayed on the UI.

This and remaining fields are config fields, with workspace changes applied on top of

mainline. This resource will be present in the workspace only if

the studio is modified (via the StudioConfig resource).

descriptiongoogle.protobuf.StringValue

description is a brief description of the studio.

templateTemplate

template is a script that builds the device configuration from the

inputs that are described by input_schema.

input_schemaInputSchema

input_schema is the schema for the studio inputs that are processed

by template.

from_packagegoogle.protobuf.StringValue

from_package indicates that this studio was created by a package, and can only be modified

by the packaging service.

StudioConfig

StudioConfig holds a configuration for a studio.

Changes to fields other than key and remove are applied to a copy of the mainline.

Field NameTypeDescription
keyStudioKey

key uniquely identifies the studio.

removegoogle.protobuf.BoolValue

remove indicates whether to remove (true) or add (false,

unset) the studio identified by the key if the encompassing

workspace merges. Other data fields are not allowed if this

field is set to true.

display_namegoogle.protobuf.StringValue

display_name is the name of this studio as displayed on the UI.

This and remaining fields are config fields, with workspace changes to be applied

on top of mainline. The corresponding Studio will be present

in the workspace only if the studio is modified (via this resource).

descriptiongoogle.protobuf.StringValue

description is a brief description of the studio.

templateTemplate

template is a script that builds the device configuration from the

inputs that are described by input_schema.

input_schemaInputSchema

input_schema is the schema for the studio inputs that are processed

by template.

StudioKey

StudioKey uniquely identifies a studio.

Field NameTypeDescription
studio_idgoogle.protobuf.StringValue

studio_id uniquely identifies the studio in the workspace indicated

by workspace_id.

workspace_idgoogle.protobuf.StringValue

workspace_id identifies the workspace within which the studio resides.

StudioSummary

StudioSummary holds basic information about a studio.

Field NameTypeDescription
keyStudioKey

key uniquely identifies the studio.

display_namegoogle.protobuf.StringValue

display_name is the name of this studio as displayed on the UI.

descriptiongoogle.protobuf.StringValue

description is a brief description of the studio.

immutablegoogle.protobuf.BoolValue

immutable indicates if read-write studio management

access over a given studio is granted or not.

If studio is immutable, its display name, description,

schema and template cannot be modified.

entitiesEntities

entities indicate all the entities of the studio.

in_usegoogle.protobuf.BoolValue

in_use indicates that the studio is in use, i.e. there are non-empty inputs,

and assigned to some devices, either in a given workspace, or in mainline.

TagMatcherInputFieldProps

TagMatcherInputFieldProps defines the set of properties for a single selector field in a studio input schema.

Field NameTypeDescription
tag_matcher_modeTagMatcherFieldMode

tag_matcher_mode (required) is the tag mode of the matcher.

tag_matcher_labelgoogle.protobuf.StringValue

tag_matcher_label can be used when tag_matcher_mode is one of

TAG_MATCHER_FIELD_MODE_SINGLE_*_TAG and it specifies

the tag label which must be used in the match query.

tag_filter_querygoogle.protobuf.StringValue

tag_filter_query limits the set of devices that the

match query can return. E.g., "device:D1,D2" will

constrain results to the devices D1 and D2.

resolver_filtering_allowedgoogle.protobuf.BoolValue

resolver_filtering_allowed indicates whether results of the

match query be filtered based on what any parent resolvers

allow. This is true by default.

Template

Template defines a template for a studio.

Field NameTypeDescription
typeTemplateType

type specifies the language that this template uses.

bodygoogle.protobuf.StringValue

body contains the actual source code of the template.

AutofillProviderType

AutofillProviderType describes the set of possible provided argument types.

NameNumberDescription
AUTOFILL_PROVIDER_TYPE_UNSPECIFIED0

AUTOFILL_PROVIDER_TYPE_UNSPECIFIED indicates that no provider type is specified.

AUTOFILL_PROVIDER_TYPE_USER_SPECIFIED1

AUTOFILL_PROVIDER_TYPE_USER_SPECIFIED is when an argument is to be

provided at runtime by the user.

AUTOFILL_PROVIDER_TYPE_PREDEFINED2

AUTOFILL_PROVIDER_TYPE_PREDEFINED is when an argument has a predefined value.

AUTOFILL_PROVIDER_TYPE_LINKED3

AUTOFILL_PROVIDER_TYPE_LINKED is when an argument is linked to another studio input field.

EntityType

EntityType enumerates the set of entity types.

NameNumberDescription
ENTITY_TYPE_UNSPECIFIED0

ENTITY_TYPE_UNSPECIFIED indicates an unspecified entity type.

ENTITY_TYPE_STUDIO1

ENTITY_TYPE_STUDIO indicates the Studio entity type.

ENTITY_TYPE_INPUTS2

ENTITY_TYPE_INPUTS indicates the Inputs entity type.

ENTITY_TYPE_ASSIGNED_TAGS3

ENTITY_TYPE_ASSIGNED_TAGS indicates the AssignedTags entity type.

ENTITY_TYPE_BUILD_HOOK4

ENTITY_TYPE_BUILD_HOOK indicates the BuildHook entity type.

ENTITY_TYPE_AUTOFILL_ACTION5

ENTITY_TYPE_AUTOFILL_ACTION indicates the AutofillAction entity type.

InputFieldType

InputFieldType defines the set of possible data types for values that can be input into a studio.

NameNumberDescription
INPUT_FIELD_TYPE_UNSPECIFIED0

INPUT_FIELD_TYPE_UNSPECIFIED indicates an unspecified input data type.

INPUT_FIELD_TYPE_BOOLEAN1

INPUT_FIELD_TYPE_BOOLEAN is the data type for a boolean value.

INPUT_FIELD_TYPE_INTEGER2

INPUT_FIELD_TYPE_INTEGER is the data type for an integer value.

INPUT_FIELD_TYPE_FLOAT3

INPUT_FIELD_TYPE_FLOAT is the data type for a float value.

INPUT_FIELD_TYPE_STRING4

INPUT_FIELD_TYPE_STRING is the data type for a string value.

INPUT_FIELD_TYPE_GROUP5

INPUT_FIELD_TYPE_GROUP is the data type for an unordered group of

inputs of any type. This type is used in cases where inputs are

required to be consolidated into an object for use in the template

or to attach multiple inputs under a resolver or collection.

INPUT_FIELD_TYPE_COLLECTION6

INPUT_FIELD_TYPE_COLLECTION is the data type for an ordered collection

of inputs of the same type. This type is used in cases where multiple

input values of the same type should be given for a field, and where

ordering matters.

INPUT_FIELD_TYPE_RESOLVER7

INPUT_FIELD_TYPE_RESOLVER is the data type for an input that allows

its member input to be assigned based on a tag query match. This

type is used in cases where the input value is conditional on a

device or a group of devices. The query is resolved at run-time

and each affected device is given the value that corresponds to

the tag it is assigned to.

INPUT_FIELD_TYPE_TAG_MATCHER8

INPUT_FIELD_TYPE_TAG_MATCHER is the data type for an input that allows

an unordered set of devices or interfaces to be selected. The set of

devices or interfaces that are to be selected are specified by a tag

query, resolved at run-time.

ResolverFieldDisplayMode

ResolverFieldDisplayMode defines the set of ways in which the matching devices or interfaces should be displayed on the UI.

NameNumberDescription
RESOLVER_FIELD_DISPLAY_MODE_UNSPECIFIED0

RESOLVER_FIELD_DISPLAY_MODE_UNSPECIFIED indicates an unspecified resolver display mode.

RESOLVER_FIELD_DISPLAY_MODE_ALL1

RESOLVER_FIELD_DISPLAY_MODE_ALL instructs the UI to show all

matching devices or interfaces, including ones that have no

inputs.

RESOLVER_FIELD_DISPLAY_MODE_SPARSE2

RESOLVER_FIELD_DISPLAY_MODE_SPARSE instructs the UI to show

only matching devices or interfaces that have inputs.

ResolverFieldInputMode

ResolverFieldInputMode defines the set of ways a resolver tag query can be specified in a studio.

NameNumberDescription
RESOLVER_FIELD_INPUT_MODE_UNSPECIFIED0

RESOLVER_FIELD_INPUT_MODE_UNSPECIFIED indicates an unspecified resolver input mode.

RESOLVER_FIELD_INPUT_MODE_SINGLE_DEVICE_TAG1

RESOLVER_FIELD_INPUT_MODE_SINGLE_DEVICE_TAG allows devices to be

selected based on a single tag label.

RESOLVER_FIELD_INPUT_MODE_SINGLE_INTERFACE_TAG2

RESOLVER_FIELD_INPUT_MODE_SINGLE_INTERFACE_TAG allows interfaces

to be selected based on a single tag label.

RESOLVER_FIELD_INPUT_MODE_MULTI_DEVICE_TAG3

RESOLVER_FIELD_INPUT_MODE_MULTI_DEVICE_TAG allows devices to be

selected based on any tag label.

RESOLVER_FIELD_INPUT_MODE_MULTI_INTERFACE_TAG4

RESOLVER_FIELD_INPUT_MODE_MULTI_INTERFACE_TAG allows interfaces

to be selected based on any tag label.

TagMatcherFieldMode

TagMatcherFieldMode defines the set of ways a tag query for matching device or interfaces can be specified in a studio.

NameNumberDescription
TAG_MATCHER_FIELD_MODE_UNSPECIFIED0

TAG_MATCHER_FIELD_MODE_UNSPECIFIED indicates an unspecified tag matcher mode.

TAG_MATCHER_FIELD_MODE_SINGLE_DEVICE_TAG1

TAG_MATCHER_FIELD_MODE_SINGLE_DEVICE_TAG allows devices to be

selected based on a single tag label.

TAG_MATCHER_FIELD_MODE_SINGLE_INTERFACE_TAG2

TAG_MATCHER_FIELD_MODE_SINGLE_INTERFACE_TAG allows interfaces

to be selected based on a single tag label.

TAG_MATCHER_FIELD_MODE_MULTI_DEVICE_TAG3

TAG_MATCHER_FIELD_MODE_MULTI_DEVICE_TAG allows devices to be

selected based on any tag label.

TAG_MATCHER_FIELD_MODE_MULTI_INTERFACE_TAG4

TAG_MATCHER_FIELD_MODE_MULTI_INTERFACE_TAG allows interfaces

to be selected based on any tag label.

TemplateType

TemplateType defines the set of supported languages that can be used in studio templates.

NameNumberDescription
TEMPLATE_TYPE_UNSPECIFIED0

TEMPLATE_TYPE_UNSPECIFIED indicates an unspecified template type.

TEMPLATE_TYPE_MAKO1

TEMPLATE_TYPE_MAKO is the Mako templating language for Python.

More information: https://www.makotemplates.org

TEMPLATE_TYPE_JINJA2

TEMPLATE_TYPE_JINJA is the Jinja templating language for Python.

More information: https://palletsprojects.com/p/jinja

TEMPLATE_TYPE_GO3

TEMPLATE_TYPE_GO is the Go templating language.

More information: https://pkg.go.dev/text/template

NOTE: Not all template functions are supported for this type.

Top

arista/studio.v1/services.gen.proto

AssignedTagsConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterAssignedTagsConfig[…]

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.

AssignedTagsConfigDeleteAllResponse

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.

keyStudioKey

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

timegoogle.protobuf.Timestamp

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

AssignedTagsConfigDeleteRequest

Field NameTypeDescription
keyStudioKey

Key indicates which AssignedTagsConfig instance to remove.

This field must always be set.

AssignedTagsConfigDeleteResponse

Field NameTypeDescription
keyStudioKey

Key echoes back the key of the deleted AssignedTagsConfig 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.

AssignedTagsConfigDeleteSomeRequest

Field NameTypeDescription
keysStudioKey[…]

key contains a list of AssignedTagsConfig keys to delete

AssignedTagsConfigDeleteSomeResponse

AssignedTagsConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyStudioKey

errorstring

AssignedTagsConfigRequest

Field NameTypeDescription
keyStudioKey

Key uniquely identifies a AssignedTagsConfig 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.

AssignedTagsConfigResponse

Field NameTypeDescription
valueAssignedTagsConfig

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

AssignedTagsConfig instance in this response.

AssignedTagsConfigSetRequest

Field NameTypeDescription
valueAssignedTagsConfig

AssignedTagsConfig carries the value to set into the datastore.

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

AssignedTagsConfigSetResponse

Field NameTypeDescription
valueAssignedTagsConfig

Value carries all the values given in the AssignedTagsConfigSetRequest 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.

AssignedTagsConfigSetSomeRequest

Field NameTypeDescription
valuesAssignedTagsConfig[…]

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

AssignedTagsConfigSetSomeResponse

Field NameTypeDescription
keyStudioKey

errorstring

AssignedTagsConfigSomeRequest

Field NameTypeDescription
keysStudioKey[…]

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.

AssignedTagsConfigSomeResponse

Field NameTypeDescription
valueAssignedTagsConfig

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

AssignedTagsConfigStreamRequest

Field NameTypeDescription
partial_eq_filterAssignedTagsConfig[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

AssignedTagsConfigStreamResponse

Field NameTypeDescription
valueAssignedTagsConfig

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 AssignedTagsConfig’s last modification.

typearista.subscriptions.Operation

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

AssignedTagsRequest

Field NameTypeDescription
keyStudioKey

Key uniquely identifies a AssignedTags 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.

AssignedTagsResponse

Field NameTypeDescription
valueAssignedTags

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

AssignedTags instance in this response.

AssignedTagsSomeRequest

Field NameTypeDescription
keysStudioKey[…]

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.

AssignedTagsSomeResponse

Field NameTypeDescription
valueAssignedTags

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

AssignedTagsStreamRequest

Field NameTypeDescription
partial_eq_filterAssignedTags[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

AssignedTagsStreamResponse

Field NameTypeDescription
valueAssignedTags

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 AssignedTags’s last modification.

typearista.subscriptions.Operation

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

AutofillActionConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterAutofillActionConfig[…]

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.

AutofillActionConfigDeleteAllResponse

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.

keyAutofillActionKey

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

timegoogle.protobuf.Timestamp

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

AutofillActionConfigDeleteRequest

Field NameTypeDescription
keyAutofillActionKey

Key indicates which AutofillActionConfig instance to remove.

This field must always be set.

AutofillActionConfigDeleteResponse

Field NameTypeDescription
keyAutofillActionKey

Key echoes back the key of the deleted AutofillActionConfig 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.

AutofillActionConfigDeleteSomeRequest

Field NameTypeDescription
keysAutofillActionKey[…]

key contains a list of AutofillActionConfig keys to delete

AutofillActionConfigDeleteSomeResponse

AutofillActionConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyAutofillActionKey

errorstring

AutofillActionConfigRequest

Field NameTypeDescription
keyAutofillActionKey

Key uniquely identifies a AutofillActionConfig 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.

AutofillActionConfigResponse

Field NameTypeDescription
valueAutofillActionConfig

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

AutofillActionConfig instance in this response.

AutofillActionConfigSetRequest

Field NameTypeDescription
valueAutofillActionConfig

AutofillActionConfig carries the value to set into the datastore.

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

AutofillActionConfigSetResponse

Field NameTypeDescription
valueAutofillActionConfig

Value carries all the values given in the AutofillActionConfigSetRequest 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.

AutofillActionConfigSetSomeRequest

Field NameTypeDescription
valuesAutofillActionConfig[…]

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

AutofillActionConfigSetSomeResponse

Field NameTypeDescription
keyAutofillActionKey

errorstring

AutofillActionConfigSomeRequest

Field NameTypeDescription
keysAutofillActionKey[…]

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.

AutofillActionConfigSomeResponse

Field NameTypeDescription
valueAutofillActionConfig

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

AutofillActionConfigStreamRequest

Field NameTypeDescription
partial_eq_filterAutofillActionConfig[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

AutofillActionConfigStreamResponse

Field NameTypeDescription
valueAutofillActionConfig

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 AutofillActionConfig’s last modification.

typearista.subscriptions.Operation

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

AutofillActionRequest

Field NameTypeDescription
keyAutofillActionKey

Key uniquely identifies a AutofillAction 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.

AutofillActionResponse

Field NameTypeDescription
valueAutofillAction

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

AutofillAction instance in this response.

AutofillActionSomeRequest

Field NameTypeDescription
keysAutofillActionKey[…]

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.

AutofillActionSomeResponse

Field NameTypeDescription
valueAutofillAction

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

AutofillActionStreamRequest

Field NameTypeDescription
partial_eq_filterAutofillAction[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

AutofillActionStreamResponse

Field NameTypeDescription
valueAutofillAction

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 AutofillAction’s last modification.

typearista.subscriptions.Operation

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

InputsConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterInputsConfig[…]

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.

InputsConfigDeleteAllResponse

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.

keyInputsKey

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

timegoogle.protobuf.Timestamp

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

InputsConfigDeleteRequest

Field NameTypeDescription
keyInputsKey

Key indicates which InputsConfig instance to remove.

This field must always be set.

InputsConfigDeleteResponse

Field NameTypeDescription
keyInputsKey

Key echoes back the key of the deleted InputsConfig 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.

InputsConfigDeleteSomeRequest

Field NameTypeDescription
keysInputsKey[…]

key contains a list of InputsConfig keys to delete

InputsConfigDeleteSomeResponse

InputsConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyInputsKey

errorstring

InputsConfigRequest

Field NameTypeDescription
keyInputsKey

Key uniquely identifies a InputsConfig 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.

InputsConfigResponse

Field NameTypeDescription
valueInputsConfig

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

InputsConfig instance in this response.

InputsConfigSetRequest

Field NameTypeDescription
valueInputsConfig

InputsConfig carries the value to set into the datastore.

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

InputsConfigSetResponse

Field NameTypeDescription
valueInputsConfig

Value carries all the values given in the InputsConfigSetRequest 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.

InputsConfigSetSomeRequest

Field NameTypeDescription
valuesInputsConfig[…]

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

InputsConfigSetSomeResponse

Field NameTypeDescription
keyInputsKey

errorstring

InputsConfigSomeRequest

Field NameTypeDescription
keysInputsKey[…]

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.

InputsConfigSomeResponse

Field NameTypeDescription
valueInputsConfig

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

InputsConfigStreamRequest

Field NameTypeDescription
partial_eq_filterInputsConfig[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

InputsConfigStreamResponse

Field NameTypeDescription
valueInputsConfig

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 InputsConfig’s last modification.

typearista.subscriptions.Operation

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

InputsRequest

Field NameTypeDescription
keyInputsKey

Key uniquely identifies a Inputs 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.

InputsResponse

Field NameTypeDescription
valueInputs

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

Inputs instance in this response.

InputsSomeRequest

Field NameTypeDescription
keysInputsKey[…]

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.

InputsSomeResponse

Field NameTypeDescription
valueInputs

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

InputsStreamRequest

Field NameTypeDescription
partial_eq_filterInputs[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

InputsStreamResponse

Field NameTypeDescription
valueInputs

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 Inputs’s last modification.

typearista.subscriptions.Operation

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

SecretInputRequest

Field NameTypeDescription
keyInputsKey

Key uniquely identifies a SecretInput 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.

SecretInputResponse

Field NameTypeDescription
valueSecretInput

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

SecretInput instance in this response.

SecretInputSomeRequest

Field NameTypeDescription
keysInputsKey[…]

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.

SecretInputSomeResponse

Field NameTypeDescription
valueSecretInput

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

SecretInputStreamRequest

Field NameTypeDescription
partial_eq_filterSecretInput[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

SecretInputStreamResponse

Field NameTypeDescription
valueSecretInput

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 SecretInput’s last modification.

typearista.subscriptions.Operation

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

StudioConfigDeleteAllRequest

Field NameTypeDescription
partial_eq_filterStudioConfig[…]

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.

StudioConfigDeleteAllResponse

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.

keyStudioKey

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

timegoogle.protobuf.Timestamp

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

StudioConfigDeleteRequest

Field NameTypeDescription
keyStudioKey

Key indicates which StudioConfig instance to remove.

This field must always be set.

StudioConfigDeleteResponse

Field NameTypeDescription
keyStudioKey

Key echoes back the key of the deleted StudioConfig 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.

StudioConfigDeleteSomeRequest

Field NameTypeDescription
keysStudioKey[…]

key contains a list of StudioConfig keys to delete

StudioConfigDeleteSomeResponse

StudioConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyStudioKey

errorstring

StudioConfigRequest

Field NameTypeDescription
keyStudioKey

Key uniquely identifies a StudioConfig 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.

StudioConfigResponse

Field NameTypeDescription
valueStudioConfig

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

StudioConfig instance in this response.

StudioConfigSetRequest

Field NameTypeDescription
valueStudioConfig

StudioConfig carries the value to set into the datastore.

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

StudioConfigSetResponse

Field NameTypeDescription
valueStudioConfig

Value carries all the values given in the StudioConfigSetRequest 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.

StudioConfigSetSomeRequest

Field NameTypeDescription
valuesStudioConfig[…]

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

StudioConfigSetSomeResponse

Field NameTypeDescription
keyStudioKey

errorstring

StudioConfigSomeRequest

Field NameTypeDescription
keysStudioKey[…]

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.

StudioConfigSomeResponse

Field NameTypeDescription
valueStudioConfig

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

StudioConfigStreamRequest

Field NameTypeDescription
partial_eq_filterStudioConfig[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

StudioConfigStreamResponse

Field NameTypeDescription
valueStudioConfig

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 StudioConfig’s last modification.

typearista.subscriptions.Operation

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

StudioRequest

Field NameTypeDescription
keyStudioKey

Key uniquely identifies a Studio 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.

StudioResponse

Field NameTypeDescription
valueStudio

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

Studio instance in this response.

StudioSomeRequest

Field NameTypeDescription
keysStudioKey[…]

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.

StudioSomeResponse

Field NameTypeDescription
valueStudio

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

StudioStreamRequest

Field NameTypeDescription
partial_eq_filterStudio[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

StudioStreamResponse

Field NameTypeDescription
valueStudio

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 Studio’s last modification.

typearista.subscriptions.Operation

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

StudioSummaryRequest

Field NameTypeDescription
keyStudioKey

Key uniquely identifies a StudioSummary 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.

StudioSummaryResponse

Field NameTypeDescription
valueStudioSummary

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

StudioSummary instance in this response.

StudioSummarySomeRequest

Field NameTypeDescription
keysStudioKey[…]

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.

StudioSummarySomeResponse

Field NameTypeDescription
valueStudioSummary

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

StudioSummaryStreamRequest

Field NameTypeDescription
partial_eq_filterStudioSummary[…]

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

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

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

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

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

until end.

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

be partial.

This field is not allowed in the Subscribe RPC.

StudioSummaryStreamResponse

Field NameTypeDescription
valueStudioSummary

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 StudioSummary’s last modification.

typearista.subscriptions.Operation

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

AssignedTagsConfigService

Method NameRequest TypeResponse TypeDescription
GetOneAssignedTagsConfigRequestAssignedTagsConfigResponse

GetSomeAssignedTagsConfigSomeRequestAssignedTagsConfigSomeResponse stream

GetAllAssignedTagsConfigStreamRequestAssignedTagsConfigStreamResponse stream

SubscribeAssignedTagsConfigStreamRequestAssignedTagsConfigStreamResponse stream

GetMetaAssignedTagsConfigStreamRequestMetaResponse

SubscribeMetaAssignedTagsConfigStreamRequestMetaResponse stream

SetAssignedTagsConfigSetRequestAssignedTagsConfigSetResponse

SetSomeAssignedTagsConfigSetSomeRequestAssignedTagsConfigSetSomeResponse stream

DeleteAssignedTagsConfigDeleteRequestAssignedTagsConfigDeleteResponse

DeleteSomeAssignedTagsConfigDeleteSomeRequestAssignedTagsConfigDeleteSomeResponse stream

DeleteAllAssignedTagsConfigDeleteAllRequestAssignedTagsConfigDeleteAllResponse stream

AssignedTagsService

Method NameRequest TypeResponse TypeDescription
GetOneAssignedTagsRequestAssignedTagsResponse

GetSomeAssignedTagsSomeRequestAssignedTagsSomeResponse stream

GetAllAssignedTagsStreamRequestAssignedTagsStreamResponse stream

SubscribeAssignedTagsStreamRequestAssignedTagsStreamResponse stream

GetMetaAssignedTagsStreamRequestMetaResponse

SubscribeMetaAssignedTagsStreamRequestMetaResponse stream

AutofillActionConfigService

Method NameRequest TypeResponse TypeDescription
GetOneAutofillActionConfigRequestAutofillActionConfigResponse

GetSomeAutofillActionConfigSomeRequestAutofillActionConfigSomeResponse stream

GetAllAutofillActionConfigStreamRequestAutofillActionConfigStreamResponse stream

SubscribeAutofillActionConfigStreamRequestAutofillActionConfigStreamResponse stream

GetMetaAutofillActionConfigStreamRequestMetaResponse

SubscribeMetaAutofillActionConfigStreamRequestMetaResponse stream

SetAutofillActionConfigSetRequestAutofillActionConfigSetResponse

SetSomeAutofillActionConfigSetSomeRequestAutofillActionConfigSetSomeResponse stream

DeleteAutofillActionConfigDeleteRequestAutofillActionConfigDeleteResponse

DeleteSomeAutofillActionConfigDeleteSomeRequestAutofillActionConfigDeleteSomeResponse stream

DeleteAllAutofillActionConfigDeleteAllRequestAutofillActionConfigDeleteAllResponse stream

AutofillActionService

Method NameRequest TypeResponse TypeDescription
GetOneAutofillActionRequestAutofillActionResponse

GetSomeAutofillActionSomeRequestAutofillActionSomeResponse stream

GetAllAutofillActionStreamRequestAutofillActionStreamResponse stream

SubscribeAutofillActionStreamRequestAutofillActionStreamResponse stream

GetMetaAutofillActionStreamRequestMetaResponse

SubscribeMetaAutofillActionStreamRequestMetaResponse stream

InputsConfigService

Method NameRequest TypeResponse TypeDescription
GetOneInputsConfigRequestInputsConfigResponse

GetSomeInputsConfigSomeRequestInputsConfigSomeResponse stream

GetAllInputsConfigStreamRequestInputsConfigStreamResponse stream

SubscribeInputsConfigStreamRequestInputsConfigStreamResponse stream

GetMetaInputsConfigStreamRequestMetaResponse

SubscribeMetaInputsConfigStreamRequestMetaResponse stream

SetInputsConfigSetRequestInputsConfigSetResponse

SetSomeInputsConfigSetSomeRequestInputsConfigSetSomeResponse stream

DeleteInputsConfigDeleteRequestInputsConfigDeleteResponse

DeleteSomeInputsConfigDeleteSomeRequestInputsConfigDeleteSomeResponse stream

DeleteAllInputsConfigDeleteAllRequestInputsConfigDeleteAllResponse stream

InputsService

Method NameRequest TypeResponse TypeDescription
GetOneInputsRequestInputsResponse

GetSomeInputsSomeRequestInputsSomeResponse stream

GetAllInputsStreamRequestInputsStreamResponse stream

SubscribeInputsStreamRequestInputsStreamResponse stream

GetMetaInputsStreamRequestMetaResponse

SubscribeMetaInputsStreamRequestMetaResponse stream

SecretInputService

Method NameRequest TypeResponse TypeDescription
GetOneSecretInputRequestSecretInputResponse

GetSomeSecretInputSomeRequestSecretInputSomeResponse stream

GetAllSecretInputStreamRequestSecretInputStreamResponse stream

SubscribeSecretInputStreamRequestSecretInputStreamResponse stream

GetMetaSecretInputStreamRequestMetaResponse

SubscribeMetaSecretInputStreamRequestMetaResponse stream

StudioConfigService

Method NameRequest TypeResponse TypeDescription
GetOneStudioConfigRequestStudioConfigResponse

GetSomeStudioConfigSomeRequestStudioConfigSomeResponse stream

GetAllStudioConfigStreamRequestStudioConfigStreamResponse stream

SubscribeStudioConfigStreamRequestStudioConfigStreamResponse stream

GetMetaStudioConfigStreamRequestMetaResponse

SubscribeMetaStudioConfigStreamRequestMetaResponse stream

SetStudioConfigSetRequestStudioConfigSetResponse

SetSomeStudioConfigSetSomeRequestStudioConfigSetSomeResponse stream

DeleteStudioConfigDeleteRequestStudioConfigDeleteResponse

DeleteSomeStudioConfigDeleteSomeRequestStudioConfigDeleteSomeResponse stream

DeleteAllStudioConfigDeleteAllRequestStudioConfigDeleteAllResponse stream

StudioService

Method NameRequest TypeResponse TypeDescription
GetOneStudioRequestStudioResponse

GetSomeStudioSomeRequestStudioSomeResponse stream

GetAllStudioStreamRequestStudioStreamResponse stream

SubscribeStudioStreamRequestStudioStreamResponse stream

GetMetaStudioStreamRequestMetaResponse

SubscribeMetaStudioStreamRequestMetaResponse stream

StudioSummaryService

Method NameRequest TypeResponse TypeDescription
GetOneStudioSummaryRequestStudioSummaryResponse

GetSomeStudioSummarySomeRequestStudioSummarySomeResponse stream

GetAllStudioSummaryStreamRequestStudioSummaryStreamResponse stream

SubscribeStudioSummaryStreamRequestStudioSummaryStreamResponse stream

GetMetaStudioSummaryStreamRequestMetaResponse

SubscribeMetaStudioSummaryStreamRequestMetaResponse stream