cloudvision.api.arista.action.v1 package

Module contents

class cloudvision.api.arista.action.v1.Action(key: ~cloudvision.api.arista.action.v1.ActionKey = <PLACEHOLDER>, core: ~cloudvision.api.arista.action.v1.ActionCore = <PLACEHOLDER>, audit: ~cloudvision.api.arista.action.v1.ActionAudit = <PLACEHOLDER>, language: ~cloudvision.api.arista.action.v1.ActionLanguage = <PLACEHOLDER>, body: str | None = <PLACEHOLDER>)[source]

Bases: Message

Action is the state model of an action.

audit: ActionAudit = <PLACEHOLDER>: audit contains meta information about the action.

body: str | None = <PLACEHOLDER>: body contains the action code (script), if applicable.

core: ActionCore = <PLACEHOLDER>: core contains some common attributes (state/config) of the action.

key: ActionKey = <PLACEHOLDER>: key uniquely identifies the action.

language: ActionLanguage = <PLACEHOLDER>: language specifies the language of the action body, if applicable.

class cloudvision.api.arista.action.v1.ActionArgConfig(key: ~cloudvision.api.arista.action.v1.ActionKey = <PLACEHOLDER>, static_args: ~cloudvision.api.arista.action.v1.ActionArgValues = <PLACEHOLDER>)[source]

Bases: Message

ActionArgConfig is the model for the definition of static arguments

key: ActionKey = <PLACEHOLDER>: key uniquely identifies the action to which the arguments apply.

static_args: ActionArgValues = <PLACEHOLDER>

static_args contains the arguments that are to be applied to all subsequent runs of the action. Argument names and values must adhere to the ActionSchema static_args.

When retrieving values of the arguments that had been set, but which are defined as hidden in ActionSchema static_args, fake hardcoded values are returned instead of the real values.

class cloudvision.api.arista.action.v1.ActionArgConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('ActionArgConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionArgConfig] = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionArgConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: ActionKey = <PLACEHOLDER>: This is the key of the ActionArgConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.action.v1.ActionArgConfigDeleteRequest(key: 'ActionKey' = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key indicates which ActionArgConfig instance to remove. This field must always be set.

class cloudvision.api.arista.action.v1.ActionArgConfigDeleteResponse(key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key echoes back the key of the deleted ActionArgConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.action.v1.ActionArgConfigDeleteSomeRequest(keys: List[ForwardRef('ActionKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionKey] = <PLACEHOLDER>: key contains a list of ActionArgConfig keys to delete

class cloudvision.api.arista.action.v1.ActionArgConfigDeleteSomeResponse(key: ~cloudvision.api.arista.action.v1.ActionKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

ActionArgConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: ActionKey = <PLACEHOLDER>

class cloudvision.api.arista.action.v1.ActionArgConfigRequest(key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key uniquely identifies a ActionArgConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionArgConfigResponse(value: 'ActionArgConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the ActionArgConfig instance in this response.

value: ActionArgConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionArgConfigServiceBase[source]

Bases: ServiceBase

async delete(action_arg_config_delete_request: ActionArgConfigDeleteRequest) → ActionArgConfigDeleteResponse[source]

async delete_all(action_arg_config_delete_all_request: ActionArgConfigDeleteAllRequest) → AsyncIterator[ActionArgConfigDeleteAllResponse][source]

async delete_some(action_arg_config_delete_some_request: ActionArgConfigDeleteSomeRequest) → AsyncIterator[ActionArgConfigDeleteSomeResponse][source]

async get_all(action_arg_config_stream_request: ActionArgConfigStreamRequest) → AsyncIterator[ActionArgConfigStreamResponse][source]

async get_meta(action_arg_config_stream_request: ActionArgConfigStreamRequest) → MetaResponse[source]

async get_one(action_arg_config_request: ActionArgConfigRequest) → ActionArgConfigResponse[source]

async get_some(action_arg_config_some_request: ActionArgConfigSomeRequest) → AsyncIterator[ActionArgConfigSomeResponse][source]

async set(action_arg_config_set_request: ActionArgConfigSetRequest) → ActionArgConfigSetResponse[source]

async set_some(action_arg_config_set_some_request: ActionArgConfigSetSomeRequest) → AsyncIterator[ActionArgConfigSetSomeResponse][source]

async subscribe(action_arg_config_stream_request: ActionArgConfigStreamRequest) → AsyncIterator[ActionArgConfigStreamResponse][source]

async subscribe_meta(action_arg_config_stream_request: ActionArgConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(action_arg_config_delete_request: ActionArgConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionArgConfigDeleteResponse[source]

async delete_all(action_arg_config_delete_all_request: ActionArgConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionArgConfigDeleteAllResponse][source]

async delete_some(action_arg_config_delete_some_request: ActionArgConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionArgConfigDeleteSomeResponse][source]

async get_all(action_arg_config_stream_request: ActionArgConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionArgConfigStreamResponse][source]

async get_meta(action_arg_config_stream_request: ActionArgConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(action_arg_config_request: ActionArgConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionArgConfigResponse[source]

async get_some(action_arg_config_some_request: ActionArgConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionArgConfigSomeResponse][source]

async set(action_arg_config_set_request: ActionArgConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionArgConfigSetResponse[source]

async set_some(action_arg_config_set_some_request: ActionArgConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionArgConfigSetSomeResponse][source]

async subscribe(action_arg_config_stream_request: ActionArgConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionArgConfigStreamResponse][source]

async subscribe_meta(action_arg_config_stream_request: ActionArgConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.action.v1.ActionArgConfigSetRequest(value: 'ActionArgConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: ActionArgConfig = <PLACEHOLDER>: ActionArgConfig carries the value to set into the datastore. See the documentation on the ActionArgConfig struct for which fields are required.

class cloudvision.api.arista.action.v1.ActionArgConfigSetResponse(value: 'ActionArgConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

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

value: ActionArgConfig = <PLACEHOLDER>: Value carries all the values given in the ActionArgConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.action.v1.ActionArgConfigSetSomeRequest(values: List[ForwardRef('ActionArgConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[ActionArgConfig] = <PLACEHOLDER>

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

class cloudvision.api.arista.action.v1.ActionArgConfigSetSomeResponse(key: 'ActionKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: ActionKey = <PLACEHOLDER>

class cloudvision.api.arista.action.v1.ActionArgConfigSomeRequest(keys: List[ForwardRef('ActionKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionArgConfigSomeResponse(value: 'ActionArgConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: ActionArgConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionArgConfigStreamRequest(partial_eq_filter: List[ForwardRef('ActionArgConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionArgConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 ActionArgConfig at end. * Each ActionArgConfig response is fully-specified (all fields set).

start: Returns the state of each ActionArgConfig at start, followed by updates until now. * Each ActionArgConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each ActionArgConfig at start, followed by updates until end. * Each ActionArgConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.action.v1.ActionArgConfigStreamResponse(value: 'ActionArgConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this ActionArgConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ActionArgConfig 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.

value: ActionArgConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionArgDefinition(required: bool | None = <PLACEHOLDER>, default: ~cloudvision.api.arista.action.v1.ActionArgValue = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, hidden: bool | None = <PLACEHOLDER>)[source]

Bases: Message

ActionArgDefinition is the definition of an argument (static or dynamic).

default: ActionArgValue = <PLACEHOLDER>: default is the default value for this argument. If set to null, there is no default value.

description: str | None = <PLACEHOLDER>: description is a user-friendly description of the argument.

hidden: bool | None = <PLACEHOLDER>: hidden can be set to true to indicate that the value of this argument can be set, but not retrieved from this API.

required: bool | None = <PLACEHOLDER>: required indicates that this argument must always be set when calling the action.

class cloudvision.api.arista.action.v1.ActionArgValue(value: str | None = <PLACEHOLDER>)[source]

Bases: Message

ActionArgValue contains the value of one argument of an action.

value: str | None = <PLACEHOLDER>: value is the string value to set the argument for runtime.

class cloudvision.api.arista.action.v1.ActionArgValues(values: ~typing.Dict[str, ~cloudvision.api.arista.action.v1.ActionArgValue] = <PLACEHOLDER>)[source]

Bases: Message

ActionArgValues contains the values of the arguments of an action.

values: Dict[str, ActionArgValue] = <PLACEHOLDER>: values is a map of arg name to value.

class cloudvision.api.arista.action.v1.ActionAudit(created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, last_modified_at: ~datetime.datetime = <PLACEHOLDER>, last_modified_by: str | None = <PLACEHOLDER>, from_package: str | None = <PLACEHOLDER>)[source]

Bases: Message

ActionAudit contains additional information for the Action state model.

created_at: datetime = <PLACEHOLDER>: created_at records the time when the action was originally created.

created_by: str | None = <PLACEHOLDER>: created_by records the user who created the action.

from_package: str | None = <PLACEHOLDER>: from_package indicates that this action was created by a package, and can only be modified by the packaging service.

last_modified_at: datetime = <PLACEHOLDER>: last_modified_at records the time when the action was most recently modified.

last_modified_by: str | None = <PLACEHOLDER>: last_modified_by records the user who most recently modified the action.

class cloudvision.api.arista.action.v1.ActionConfig(key: ~cloudvision.api.arista.action.v1.ActionKey = <PLACEHOLDER>, core: ~cloudvision.api.arista.action.v1.ActionCore = <PLACEHOLDER>, language: ~cloudvision.api.arista.action.v1.ActionLanguage = <PLACEHOLDER>, body: str | None = <PLACEHOLDER>)[source]

Bases: Message

ActionConfig is the config of an action. Unimplemented for builtin actions

body: str | None = <PLACEHOLDER>: body contains the action code (script), if applicable.

core: ActionCore = <PLACEHOLDER>: core contains some common attributes (state/config) of the action.

key: ActionKey = <PLACEHOLDER>: key uniquely identifies the action.

language: ActionLanguage = <PLACEHOLDER>: language specifies the language of the action body, if applicable.

class cloudvision.api.arista.action.v1.ActionConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('ActionConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionConfig] = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: ActionKey = <PLACEHOLDER>: This is the key of the ActionConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.action.v1.ActionConfigDeleteRequest(key: 'ActionKey' = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key indicates which ActionConfig instance to remove. This field must always be set.

class cloudvision.api.arista.action.v1.ActionConfigDeleteResponse(key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key echoes back the key of the deleted ActionConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.action.v1.ActionConfigDeleteSomeRequest(keys: List[ForwardRef('ActionKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionKey] = <PLACEHOLDER>: key contains a list of ActionConfig keys to delete

class cloudvision.api.arista.action.v1.ActionConfigDeleteSomeResponse(key: ~cloudvision.api.arista.action.v1.ActionKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

ActionConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: ActionKey = <PLACEHOLDER>

class cloudvision.api.arista.action.v1.ActionConfigRequest(key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key uniquely identifies a ActionConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionConfigResponse(value: 'ActionConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the ActionConfig instance in this response.

value: ActionConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionConfigServiceBase[source]

Bases: ServiceBase

async delete(action_config_delete_request: ActionConfigDeleteRequest) → ActionConfigDeleteResponse[source]

async delete_all(action_config_delete_all_request: ActionConfigDeleteAllRequest) → AsyncIterator[ActionConfigDeleteAllResponse][source]

async delete_some(action_config_delete_some_request: ActionConfigDeleteSomeRequest) → AsyncIterator[ActionConfigDeleteSomeResponse][source]

async get_all(action_config_stream_request: ActionConfigStreamRequest) → AsyncIterator[ActionConfigStreamResponse][source]

async get_meta(action_config_stream_request: ActionConfigStreamRequest) → MetaResponse[source]

async get_one(action_config_request: ActionConfigRequest) → ActionConfigResponse[source]

async get_some(action_config_some_request: ActionConfigSomeRequest) → AsyncIterator[ActionConfigSomeResponse][source]

async set(action_config_set_request: ActionConfigSetRequest) → ActionConfigSetResponse[source]

async set_some(action_config_set_some_request: ActionConfigSetSomeRequest) → AsyncIterator[ActionConfigSetSomeResponse][source]

async subscribe(action_config_stream_request: ActionConfigStreamRequest) → AsyncIterator[ActionConfigStreamResponse][source]

async subscribe_meta(action_config_stream_request: ActionConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(action_config_delete_request: ActionConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionConfigDeleteResponse[source]

async delete_all(action_config_delete_all_request: ActionConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionConfigDeleteAllResponse][source]

async delete_some(action_config_delete_some_request: ActionConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionConfigDeleteSomeResponse][source]

async get_all(action_config_stream_request: ActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionConfigStreamResponse][source]

async get_meta(action_config_stream_request: ActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(action_config_request: ActionConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionConfigResponse[source]

async get_some(action_config_some_request: ActionConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionConfigSomeResponse][source]

async set(action_config_set_request: ActionConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionConfigSetResponse[source]

async set_some(action_config_set_some_request: ActionConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionConfigSetSomeResponse][source]

async subscribe(action_config_stream_request: ActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionConfigStreamResponse][source]

async subscribe_meta(action_config_stream_request: ActionConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.action.v1.ActionConfigSetRequest(value: 'ActionConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: ActionConfig = <PLACEHOLDER>: ActionConfig carries the value to set into the datastore. See the documentation on the ActionConfig struct for which fields are required.

class cloudvision.api.arista.action.v1.ActionConfigSetResponse(value: 'ActionConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

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

value: ActionConfig = <PLACEHOLDER>: Value carries all the values given in the ActionConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.action.v1.ActionConfigSetSomeRequest(values: List[ForwardRef('ActionConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[ActionConfig] = <PLACEHOLDER>

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

class cloudvision.api.arista.action.v1.ActionConfigSetSomeResponse(key: 'ActionKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: ActionKey = <PLACEHOLDER>

class cloudvision.api.arista.action.v1.ActionConfigSomeRequest(keys: List[ForwardRef('ActionKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionConfigSomeResponse(value: 'ActionConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: ActionConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionConfigStreamRequest(partial_eq_filter: List[ForwardRef('ActionConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 ActionConfig at end. * Each ActionConfig response is fully-specified (all fields set).

start: Returns the state of each ActionConfig at start, followed by updates until now. * Each ActionConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each ActionConfig at start, followed by updates until end. * Each ActionConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.action.v1.ActionConfigStreamResponse(value: 'ActionConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this ActionConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ActionConfig 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.

value: ActionConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionCore(name: str | None = <PLACEHOLDER>, type: ~cloudvision.api.arista.action.v1.ActionType = <PLACEHOLDER>, description: str | None = <PLACEHOLDER>, static_args: ~cloudvision.api.arista.action.v1.ActionSchema = <PLACEHOLDER>, dynamic_args: ~cloudvision.api.arista.action.v1.ActionSchema = <PLACEHOLDER>)[source]

Bases: Message

ActionCore contains the core fields of an action.

description: str | None = <PLACEHOLDER>: description is a user-friendly description of the action.

dynamic_args: ActionSchema = <PLACEHOLDER>: dynamic_args defines arguments which are scoped to a specific run of the action. The names of arguments in dynamic_args cannot also appear in static_args.

name: str | None = <PLACEHOLDER>: name is the user-friendly name of the action.

static_args: ActionSchema = <PLACEHOLDER>: static_args defines arguments which can be permanently changed for subsequent runs of this action (set ActionArgConfig to accomplish that). The names of arguments in static_args cannot also appear in dynamic_args.

type: ActionType = <PLACEHOLDER>: type is the specific type of the action.

class cloudvision.api.arista.action.v1.ActionKey(id: str | None = <PLACEHOLDER>)[source]

Bases: Message

ActionKey is the model key of an action.

id: str | None = <PLACEHOLDER>: id uniquely identifies the action. Although chosen by the caller, it is recommended to be a random UUID.

class cloudvision.api.arista.action.v1.ActionLanguage(value: int)[source]

Bases: Enum

ActionLanguage is the language of an action.

GO_TEMPLATE = ActionLanguage.GO_TEMPLATE: ACTION_LANGUAGE_GO_TEMPLATE indicates that the action body is a Go language template (e.g. as used in ZTP).

PYTHON_2 = ActionLanguage.PYTHON_2: ACTION_LANGUAGE_PYTHON_2 indicates that the action body follows Python 2.x syntax.

PYTHON_3 = ActionLanguage.PYTHON_3: ACTION_LANGUAGE_PYTHON_3 indicates that the action body follows Python 3.x syntax.

UNSPECIFIED = ActionLanguage.UNSPECIFIED: ACTION_LANGUAGE_UNSPECIFIED is the default value for this type.

name: str | None

value: int

class cloudvision.api.arista.action.v1.ActionRequest(key: 'ActionKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionKey = <PLACEHOLDER>: Key uniquely identifies a Action instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionResponse(value: 'Action' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the Action instance in this response.

value: Action = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRun(key: ~cloudvision.api.arista.action.v1.ActionRunKey = <PLACEHOLDER>, action_id: str | None = <PLACEHOLDER>, created_at: ~datetime.datetime = <PLACEHOLDER>, created_by: str | None = <PLACEHOLDER>, finished_at: ~datetime.datetime = <PLACEHOLDER>, is_finished: bool | None = <PLACEHOLDER>, code: int | None = <PLACEHOLDER>, output: str | None = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>)[source]

Bases: Message

ActionRun is the state of a single run (single execution) of an action.

action_id: str | None = <PLACEHOLDER>: action_id uniquely identifies the Action being run.

code: int | None = <PLACEHOLDER>

code contains the exit code of the action.

The code may be ignored if error is empty or nil.

created_at: datetime = <PLACEHOLDER>: created_at records the time when the action run has been requested.

created_by: str | None = <PLACEHOLDER>: created_by records the user who requested the action execution.

error: str | None = <PLACEHOLDER>

error contains a failure description for unsuccessful runs, either caused by the body or by the execution environment.

Often it is a python traceback which contains multiple newline characters. Maximum size is 100,000 bytes.

finished_at: datetime = <PLACEHOLDER>: finished_at records the time when the action finished running.

is_finished: bool | None = <PLACEHOLDER>: is_finished is true only when the action has finished running and the fields code, output, error, and finished_at are assigned their final values.

key: ActionRunKey = <PLACEHOLDER>: key uniquely identifies the ActionRun and the corresponding ActionRunConfig.

output: str | None = <PLACEHOLDER>: output contains the output produced by the action, truncated to the first 100,000 bytes.

class cloudvision.api.arista.action.v1.ActionRunConfig(key: ~cloudvision.api.arista.action.v1.ActionRunKey = <PLACEHOLDER>, action_id: str | None = <PLACEHOLDER>, dynamic_args: ~cloudvision.api.arista.action.v1.ActionArgValues = <PLACEHOLDER>)[source]

Bases: Message

ActionRunConfig is the configuration of a single execution of an action. Creating a record under a new key triggers a run. Attempting to set again an existing entry is an error.

action_id: str | None = <PLACEHOLDER>: action_id uniquely identifies the Action being run.

dynamic_args: ActionArgValues = <PLACEHOLDER>: dynamic_args contains the values of dynamic arguments defined for the action.

key: ActionRunKey = <PLACEHOLDER>: key uniquely identifies the ActionRunConfig and the corresponding ActionRun.

class cloudvision.api.arista.action.v1.ActionRunConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('ActionRunConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionRunConfig] = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'ActionRunKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: This indicates the error message from the delete failure.

key: ActionRunKey = <PLACEHOLDER>: This is the key of the ActionRunConfig instance that failed to be deleted.

time: datetime = <PLACEHOLDER>: Time indicates the (UTC) timestamp when the key was being deleted.

type: ___fmp__.DeleteError = <PLACEHOLDER>: This describes the class of delete error. A DeleteAllResponse is only sent when there is an error.

class cloudvision.api.arista.action.v1.ActionRunConfigDeleteRequest(key: 'ActionRunKey' = <PLACEHOLDER>)[source]

Bases: Message

key: ActionRunKey = <PLACEHOLDER>: Key indicates which ActionRunConfig instance to remove. This field must always be set.

class cloudvision.api.arista.action.v1.ActionRunConfigDeleteResponse(key: 'ActionRunKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionRunKey = <PLACEHOLDER>: Key echoes back the key of the deleted ActionRunConfig instance.

time: datetime = <PLACEHOLDER>

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.

class cloudvision.api.arista.action.v1.ActionRunConfigDeleteSomeRequest(keys: List[ForwardRef('ActionRunKey')] = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionRunKey] = <PLACEHOLDER>: key contains a list of ActionRunConfig keys to delete

class cloudvision.api.arista.action.v1.ActionRunConfigDeleteSomeResponse(key: ~cloudvision.api.arista.action.v1.ActionRunKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

ActionRunConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: ActionRunKey = <PLACEHOLDER>

class cloudvision.api.arista.action.v1.ActionRunConfigRequest(key: 'ActionRunKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionRunKey = <PLACEHOLDER>: Key uniquely identifies a ActionRunConfig instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunConfigResponse(value: 'ActionRunConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the ActionRunConfig instance in this response.

value: ActionRunConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunConfigServiceBase[source]

Bases: ServiceBase

async delete(action_run_config_delete_request: ActionRunConfigDeleteRequest) → ActionRunConfigDeleteResponse[source]

async delete_all(action_run_config_delete_all_request: ActionRunConfigDeleteAllRequest) → AsyncIterator[ActionRunConfigDeleteAllResponse][source]

async delete_some(action_run_config_delete_some_request: ActionRunConfigDeleteSomeRequest) → AsyncIterator[ActionRunConfigDeleteSomeResponse][source]

async get_all(action_run_config_stream_request: ActionRunConfigStreamRequest) → AsyncIterator[ActionRunConfigStreamResponse][source]

async get_meta(action_run_config_stream_request: ActionRunConfigStreamRequest) → MetaResponse[source]

async get_one(action_run_config_request: ActionRunConfigRequest) → ActionRunConfigResponse[source]

async get_some(action_run_config_some_request: ActionRunConfigSomeRequest) → AsyncIterator[ActionRunConfigSomeResponse][source]

async set(action_run_config_set_request: ActionRunConfigSetRequest) → ActionRunConfigSetResponse[source]

async set_some(action_run_config_set_some_request: ActionRunConfigSetSomeRequest) → AsyncIterator[ActionRunConfigSetSomeResponse][source]

async subscribe(action_run_config_stream_request: ActionRunConfigStreamRequest) → AsyncIterator[ActionRunConfigStreamResponse][source]

async subscribe_meta(action_run_config_stream_request: ActionRunConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(action_run_config_delete_request: ActionRunConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionRunConfigDeleteResponse[source]

async delete_all(action_run_config_delete_all_request: ActionRunConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunConfigDeleteAllResponse][source]

async delete_some(action_run_config_delete_some_request: ActionRunConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunConfigDeleteSomeResponse][source]

async get_all(action_run_config_stream_request: ActionRunConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunConfigStreamResponse][source]

async get_meta(action_run_config_stream_request: ActionRunConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(action_run_config_request: ActionRunConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionRunConfigResponse[source]

async get_some(action_run_config_some_request: ActionRunConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunConfigSomeResponse][source]

async set(action_run_config_set_request: ActionRunConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionRunConfigSetResponse[source]

async set_some(action_run_config_set_some_request: ActionRunConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunConfigSetSomeResponse][source]

async subscribe(action_run_config_stream_request: ActionRunConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunConfigStreamResponse][source]

async subscribe_meta(action_run_config_stream_request: ActionRunConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.action.v1.ActionRunConfigSetRequest(value: 'ActionRunConfig' = <PLACEHOLDER>)[source]

Bases: Message

value: ActionRunConfig = <PLACEHOLDER>: ActionRunConfig carries the value to set into the datastore. See the documentation on the ActionRunConfig struct for which fields are required.

class cloudvision.api.arista.action.v1.ActionRunConfigSetResponse(value: 'ActionRunConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are:

it is after the time the request was received

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

value: ActionRunConfig = <PLACEHOLDER>: Value carries all the values given in the ActionRunConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.action.v1.ActionRunConfigSetSomeRequest(values: List[ForwardRef('ActionRunConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[ActionRunConfig] = <PLACEHOLDER>

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

class cloudvision.api.arista.action.v1.ActionRunConfigSetSomeResponse(key: 'ActionRunKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: ActionRunKey = <PLACEHOLDER>

class cloudvision.api.arista.action.v1.ActionRunConfigSomeRequest(keys: List[ForwardRef('ActionRunKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionRunKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunConfigSomeResponse(value: 'ActionRunConfig' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: ActionRunConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunConfigStreamRequest(partial_eq_filter: List[ForwardRef('ActionRunConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionRunConfig] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 ActionRunConfig at end. * Each ActionRunConfig response is fully-specified (all fields set).

start: Returns the state of each ActionRunConfig at start, followed by updates until now. * Each ActionRunConfig response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each ActionRunConfig at start, followed by updates until end. * Each ActionRunConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.action.v1.ActionRunConfigStreamResponse(value: 'ActionRunConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this ActionRunConfig’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ActionRunConfig 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.

value: ActionRunConfig = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunKey(run_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

ActionRunKey is the model key that can uniquely identify an action run.

run_id: str | None = <PLACEHOLDER>: run_id uniquely identifies an action run

class cloudvision.api.arista.action.v1.ActionRunRequest(key: 'ActionRunKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ActionRunKey = <PLACEHOLDER>: Key uniquely identifies a ActionRun instance to retrieve. This value must be populated.

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunResponse(value: 'ActionRun' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time carries the (UTC) timestamp of the last-modification of the ActionRun instance in this response.

value: ActionRun = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunServiceBase[source]

Bases: ServiceBase

async get_all(action_run_stream_request: ActionRunStreamRequest) → AsyncIterator[ActionRunStreamResponse][source]

async get_meta(action_run_stream_request: ActionRunStreamRequest) → MetaResponse[source]

async get_one(action_run_request: ActionRunRequest) → ActionRunResponse[source]

async get_some(action_run_some_request: ActionRunSomeRequest) → AsyncIterator[ActionRunSomeResponse][source]

async subscribe(action_run_stream_request: ActionRunStreamRequest) → AsyncIterator[ActionRunStreamResponse][source]

async subscribe_meta(action_run_stream_request: ActionRunStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(action_run_stream_request: ActionRunStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunStreamResponse][source]

async get_meta(action_run_stream_request: ActionRunStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(action_run_request: ActionRunRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionRunResponse[source]

async get_some(action_run_some_request: ActionRunSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunSomeResponse][source]

async subscribe(action_run_stream_request: ActionRunStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionRunStreamResponse][source]

async subscribe_meta(action_run_stream_request: ActionRunStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.action.v1.ActionRunSomeRequest(keys: List[ForwardRef('ActionRunKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionRunKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunSomeResponse(value: 'ActionRun' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: ActionRun = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionRunStreamRequest(partial_eq_filter: List[ForwardRef('ActionRun')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ActionRun] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 ActionRun at end. * Each ActionRun response is fully-specified (all fields set).

start: Returns the state of each ActionRun at start, followed by updates until now. * Each ActionRun response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each ActionRun at start, followed by updates until end. * Each ActionRun response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.action.v1.ActionRunStreamResponse(value: 'ActionRun' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this ActionRun’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ActionRun 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.

value: ActionRun = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionSchema(values: ~typing.Dict[str, ~cloudvision.api.arista.action.v1.ActionArgDefinition] = <PLACEHOLDER>)[source]

Bases: Message

ActionSchema is the schema of an action. Corresponds to the definition of multiple arguments.

values: Dict[str, ActionArgDefinition] = <PLACEHOLDER>: values is a map of argument name to its defintion.

class cloudvision.api.arista.action.v1.ActionServiceBase[source]

Bases: ServiceBase

async get_all(action_stream_request: ActionStreamRequest) → AsyncIterator[ActionStreamResponse][source]

async get_meta(action_stream_request: ActionStreamRequest) → MetaResponse[source]

async get_one(action_request: ActionRequest) → ActionResponse[source]

async get_some(action_some_request: ActionSomeRequest) → AsyncIterator[ActionSomeResponse][source]

async subscribe(action_stream_request: ActionStreamRequest) → AsyncIterator[ActionStreamResponse][source]

async subscribe_meta(action_stream_request: ActionStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(action_stream_request: ActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionStreamResponse][source]

async get_meta(action_stream_request: ActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → MetaResponse[source]

async get_one(action_request: ActionRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ActionResponse[source]

async get_some(action_some_request: ActionSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionSomeResponse][source]

async subscribe(action_stream_request: ActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ActionStreamResponse][source]

async subscribe_meta(action_stream_request: ActionStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MetaResponse][source]

class cloudvision.api.arista.action.v1.ActionSomeRequest(keys: List[ForwardRef('ActionKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ActionKey] = <PLACEHOLDER>

time: datetime = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionSomeResponse(value: 'Action' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

error: str | None = <PLACEHOLDER>: Error is an optional field. It should be filled when there is an error in the GetSome process.

time: datetime = <PLACEHOLDER>

value: Action = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionStreamRequest(partial_eq_filter: List[ForwardRef('Action')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Action] = <PLACEHOLDER>

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: __time__.TimeBounds = <PLACEHOLDER>

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 Action at end. * Each Action response is fully-specified (all fields set).

start: Returns the state of each Action at start, followed by updates until now. * Each Action response at start is fully-specified, but updates may be partial.

start and end: Returns the state of each Action at start, followed by updates until end. * Each Action response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

class cloudvision.api.arista.action.v1.ActionStreamResponse(value: 'Action' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>: Time holds the timestamp of this Action’s last modification.

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Action 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.

value: Action = <PLACEHOLDER>: 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.

class cloudvision.api.arista.action.v1.ActionType(value: int)[source]

Bases: Enum

ActionType is the type of an action.

CHANGECONTROL_BUILT_IN = ActionType.CHANGECONTROL_BUILT_IN: ACTION_TYPE_CHANGECONTROL_BUILT_IN indicates a built-in action with no scripted component which can be used as part of a change control.

CHANGECONTROL_CUSTOM = ActionType.CHANGECONTROL_CUSTOM: ACTION_TYPE_CHANGECONTROL_CUSTOM indicates a scripted action that can be used as part of a change control.

PACKAGING_INSTALL_HOOK = ActionType.PACKAGING_INSTALL_HOOK: ACTION_TYPE_PACKAGING_INSTALL_HOOK is a type of Action which can run during package lifecycle events (e.g. pre-install or post-uninstall) to handle any migration or configuration changes that need to happen for a Package to be (un)installed successfully.

STUDIO_AUTOFILL = ActionType.STUDIO_AUTOFILL: ACTION_TYPE_STUDIO_AUTOFILL is an action which can be bound to an input in a studio.

STUDIO_BUILD_HOOK = ActionType.STUDIO_BUILD_HOOK

ACTION_TYPE_STUDIO_BUILD_HOOK is a type of Action which can run at various points in a workspace build pipeline (e.g. workspace pre-build, studio pre-render), facilitating customization of the workspace build beyond the standard process. Build hooks in a given stage can express dependencies on each other which allows ordering of the actions’ execution.

For ACTION_TYPE_STUDIO_BUILD_HOOK each hook invocation will provide the following arguments:

WorkspaceID (mandatory): the ID of the Workspace
StudioID (optional, if running in the context of a Studio): the ID of the Studio

UNSPECIFIED = ActionType.UNSPECIFIED: ACTION_TYPE_UNSPECIFIED is the default value for this type.

ZTP_BOOTSTRAP = ActionType.ZTP_BOOTSTRAP: ACTION_TYPE_ZTP_BOOTSTRAP is a type of Action which can be used to bootstrap a device.

name: str | None

value: int

class cloudvision.api.arista.action.v1.MetaResponse(time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>, count: int | None = <PLACEHOLDER>)[source]

Bases: Message

count: int | None = <PLACEHOLDER>: Count is the number of items present under the conditions of the request.

time: datetime = <PLACEHOLDER>: Time holds the timestamp of the last item included in the metadata calculation.

type: __subscriptions__.Operation = <PLACEHOLDER>: 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.