cloudvision.api.arista.configstatus.v1 package

Module contents

class cloudvision.api.arista.configstatus.v1.ConfigDiff(key: ~cloudvision.api.arista.configstatus.v1.ConfigDiffKey = <PLACEHOLDER>, uri: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigDiff - specifies the diff request

key: ConfigDiffKey = <PLACEHOLDER>

key represents config diff key

uri: str | None = <PLACEHOLDER>

uri represents the HTTP URI client can use to GET config diff and associated errors

class cloudvision.api.arista.configstatus.v1.ConfigDiffBatchedStreamRequest(partial_eq_filter: List[ForwardRef('ConfigDiff')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[ConfigDiff] = <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 ConfigDiff at end. * Each ConfigDiff response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.ConfigDiffBatchedStreamResponse(responses: List[ForwardRef('ConfigDiffStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ConfigDiffStreamResponse] = <PLACEHOLDER>

Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.configstatus.v1.ConfigDiffKey(a_device_id: str | None = <PLACEHOLDER>, a_type: ~cloudvision.api.arista.configstatus.v1.ConfigType = <PLACEHOLDER>, a_time: ~datetime.datetime = <PLACEHOLDER>, b_device_id: str | None = <PLACEHOLDER>, b_type: ~cloudvision.api.arista.configstatus.v1.ConfigType = <PLACEHOLDER>, b_time: ~datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

ConfigDiffKey uniquely identifies a configuration diff request

a_device_id: str | None = <PLACEHOLDER>

a_device_id is the serial number of the device on A side (left hand side)

a_time: datetime = <PLACEHOLDER>

a_time is the time at which to fetch config on A side (left hand side)

a_type: ConfigType = <PLACEHOLDER>

a_type is the config type on A side (left hand side)

b_device_id: str | None = <PLACEHOLDER>

b_device_id is the serial number of the device on B side (right hand side)

b_time: datetime = <PLACEHOLDER>

b_time is the time at which to fetch config on B side (right hand side)

b_type: ConfigType = <PLACEHOLDER>

b_type is the config type on B side (right hand side)

class cloudvision.api.arista.configstatus.v1.ConfigDiffRequest(key: 'ConfigDiffKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigDiffKey = <PLACEHOLDER>

Key uniquely identifies a ConfigDiff 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.configstatus.v1.ConfigDiffResponse(value: 'ConfigDiff' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the ConfigDiff instance in this response.

value: ConfigDiff = <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.configstatus.v1.ConfigDiffServiceBase[source]

Bases: ServiceBase

async get_all(config_diff_stream_request: ConfigDiffStreamRequest) AsyncIterator[ConfigDiffStreamResponse][source]
async get_all_batched(config_diff_batched_stream_request: ConfigDiffBatchedStreamRequest) AsyncIterator[ConfigDiffBatchedStreamResponse][source]
async get_meta(config_diff_stream_request: ConfigDiffStreamRequest) MetaResponse[source]
async get_one(config_diff_request: ConfigDiffRequest) ConfigDiffResponse[source]
async get_some(config_diff_some_request: ConfigDiffSomeRequest) AsyncIterator[ConfigDiffSomeResponse][source]
async subscribe(config_diff_stream_request: ConfigDiffStreamRequest) AsyncIterator[ConfigDiffStreamResponse][source]
async subscribe_batched(config_diff_batched_stream_request: ConfigDiffBatchedStreamRequest) AsyncIterator[ConfigDiffBatchedStreamResponse][source]
async subscribe_meta(config_diff_stream_request: ConfigDiffStreamRequest) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.ConfigDiffServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(config_diff_stream_request: ConfigDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigDiffStreamResponse][source]
async get_all_batched(config_diff_batched_stream_request: ConfigDiffBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigDiffBatchedStreamResponse][source]
async get_meta(config_diff_stream_request: ConfigDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) MetaResponse[source]
async get_one(config_diff_request: ConfigDiffRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) ConfigDiffResponse[source]
async get_some(config_diff_some_request: ConfigDiffSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigDiffSomeResponse][source]
async subscribe(config_diff_stream_request: ConfigDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigDiffStreamResponse][source]
async subscribe_batched(config_diff_batched_stream_request: ConfigDiffBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigDiffBatchedStreamResponse][source]
async subscribe_meta(config_diff_stream_request: ConfigDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.ConfigDiffSomeRequest(keys: List[ForwardRef('ConfigDiffKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ConfigDiffKey] = <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.configstatus.v1.ConfigDiffSomeResponse(value: 'ConfigDiff' = <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>

Time carries the (UTC) timestamp of the last-modification of the ConfigDiff instance in this response.

value: ConfigDiff = <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.configstatus.v1.ConfigDiffStreamRequest(partial_eq_filter: List[ForwardRef('ConfigDiff')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ConfigDiff] = <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 ConfigDiff at end. * Each ConfigDiff response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.ConfigDiffStreamResponse(value: 'ConfigDiff' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the ConfigDiff 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: ConfigDiff = <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.configstatus.v1.ConfigError(error_code: ~cloudvision.api.arista.configstatus.v1.ErrorCode = <PLACEHOLDER>, error_msg: str | None = <PLACEHOLDER>, line_num: int | None = <PLACEHOLDER>, configlet_name: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigError represents errors reported by CVP/EOS when handling device configuration

configlet_name: str | None = <PLACEHOLDER>

configlet_name represents the originating configlet name. Configlet_name and line_num point to the line where config warning or config error originate.

error_code: ErrorCode = <PLACEHOLDER>

error_code - type of error.

error_msg: str | None = <PLACEHOLDER>

error_msg - details of error

line_num: int | None = <PLACEHOLDER>

line_num represents line number, if any

class cloudvision.api.arista.configstatus.v1.ConfigErrors(values: ~typing.List[~cloudvision.api.arista.configstatus.v1.ConfigError] = <PLACEHOLDER>)[source]

Bases: Message

ConfigErrors list of errors

values: List[ConfigError] = <PLACEHOLDER>

values - list of errors

class cloudvision.api.arista.configstatus.v1.ConfigFilterCode(value: int)[source]

Bases: Enum

ConfigFilterCode indicates if a config line matches PCM filter(s)

MANAGED_LINE = ConfigFilterCode.MANAGED_LINE

CONFIG_FILTER_CODE_MANAGED_LINE indicates config line matches managed PCM filter hence is managed

UNMANAGED_LINE = ConfigFilterCode.UNMANAGED_LINE

CONFIG_FILTER_CODE_UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed

UNSPECIFIED = ConfigFilterCode.UNSPECIFIED

CONFIG_FILTER_CODE_UNSPECIFIED uninitialized

name: str | None
value: int
class cloudvision.api.arista.configstatus.v1.ConfigKey(device_id: str | None = <PLACEHOLDER>, type: ~cloudvision.api.arista.configstatus.v1.ConfigType = <PLACEHOLDER>)[source]

Bases: Message

ConfigKey uniquely identifies a config request.

device_id: str | None = <PLACEHOLDER>

device_id is the serial number of the device

type: ConfigType = <PLACEHOLDER>

type describes the config type

class cloudvision.api.arista.configstatus.v1.ConfigSource(source_type: ~cloudvision.api.arista.configstatus.v1.ConfigSourceType = <PLACEHOLDER>, source_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigSource describes an individual source of the proposed/designed config

source_id: str | None = <PLACEHOLDER>

source_id identifier to distinguish between multiple instances of the source type source_id is :

configlet name for CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET studio id for CONFIG_SOURCE_TYPE_STUDIO configlet id for CONFIG_SOURCE_TYPE_STUDIO_STATIC FixtureInstance id for CONFIG_SOURCE_TYPE_HIERARCHY

source_type: ConfigSourceType = <PLACEHOLDER>

source_type - app type of the config snippet

class cloudvision.api.arista.configstatus.v1.ConfigSourceType(value: int)[source]

Bases: Enum

ConfigSourceType indicates the type of source for the proposed/designed configuration for the device

HIERARCHY = ConfigSourceType.HIERARCHY

CONFIG_SOURCE_TYPE_HIERARCHY - config from the hierarchy frameork

NETWORK_PROVISIONING_CONFIGLET = ConfigSourceType.NETWORK_PROVISIONING_CONFIGLET

CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET - configlet created from the network provisioning workflow.

STUDIO = ConfigSourceType.STUDIO

CONFIG_SOURCE_TYPE_STUDIO - config generated from a regular studio

STUDIO_STATIC = ConfigSourceType.STUDIO_STATIC

CONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework

UNSPECIFIED = ConfigSourceType.UNSPECIFIED

CONFIG_SOURCE_TYPE_UNSPECIFIED uninitialized value

name: str | None
value: int
class cloudvision.api.arista.configstatus.v1.ConfigSources(values: ~typing.List[~cloudvision.api.arista.configstatus.v1.ConfigSource] = <PLACEHOLDER>)[source]

Bases: Message

ConfigSources is the list of sources of the proposed/designed config

values: List[ConfigSource] = <PLACEHOLDER>

values - ordered list of all the config snippets present in DC

class cloudvision.api.arista.configstatus.v1.ConfigSummary(sync: ~cloudvision.api.arista.configstatus.v1.ConfigSyncCode = <PLACEHOLDER>, nop_lines: int | None = <PLACEHOLDER>, ignored_lines: int | None = <PLACEHOLDER>, added_lines: int | None = <PLACEHOLDER>, deleted_lines: int | None = <PLACEHOLDER>, changed_lines: int | None = <PLACEHOLDER>, designed_config_errors: int | None = <PLACEHOLDER>, designed_config_warnings: int | None = <PLACEHOLDER>, running_config_update_time: ~datetime.datetime = <PLACEHOLDER>, designed_config_update_time: ~datetime.datetime = <PLACEHOLDER>, running_config_uri: str | None = <PLACEHOLDER>, designed_config_uri: str | None = <PLACEHOLDER>, diff_uri: str | None = <PLACEHOLDER>, digest: str | None = <PLACEHOLDER>)[source]

Bases: Message

ConfigSummary represents device configuration summary.

added_lines: int | None = <PLACEHOLDER>

added_lines - Number of lines with code ADD

changed_lines: int | None = <PLACEHOLDER>

changed_lines - Number of lines with code CHANGE

deleted_lines: int | None = <PLACEHOLDER>

deleted_lines - Number of lines with code DELETE

designed_config_errors: int | None = <PLACEHOLDER>

designed_config_errors - Number of designed config errors

designed_config_update_time: datetime = <PLACEHOLDER>

designed_config_update_time - Timestamp at which designed config is updated

designed_config_uri: str | None = <PLACEHOLDER>

designed_config_uri - The HTTP URI client can use to GET designed config and associated errors

designed_config_warnings: int | None = <PLACEHOLDER>

designed_config_warnings - Number of designed config warnings

diff_uri: str | None = <PLACEHOLDER>

diff_uri - The HTTP URI client can use to GET config diff and associated errors

digest: str | None = <PLACEHOLDER>

digest (SHA-256) of the config diff.

ignored_lines: int | None = <PLACEHOLDER>

ignored_lines - Number of lines with code IGNORE

nop_lines: int | None = <PLACEHOLDER>

nop_lines - Number of lines with code no-operation

running_config_update_time: datetime = <PLACEHOLDER>

running_config_update_time - Timestamp at which running config is updated

running_config_uri: str | None = <PLACEHOLDER>

running_config_uri - The HTTP URI client can use to GET running config and associated errors

sync: ConfigSyncCode = <PLACEHOLDER>

sync - state of DC vs RC

class cloudvision.api.arista.configstatus.v1.ConfigSyncCode(value: int)[source]

Bases: Enum

ConfigSyncCode indicates config synchronization status

IN_SYNC = ConfigSyncCode.IN_SYNC

CONFIG_SYNC_CODE_IN_SYNC indicates designed config and running config are identical

OUT_OF_SYNC = ConfigSyncCode.OUT_OF_SYNC

CONFIG_SYNC_CODE_OUT_OF_SYNC indicates designed config and running config are not identical

UNSPECIFIED = ConfigSyncCode.UNSPECIFIED

CONFIG_SYNC_CODE_UNSPECIFIED uninitialized

name: str | None
value: int
class cloudvision.api.arista.configstatus.v1.ConfigType(value: int)[source]

Bases: Enum

ConfigType - specifies type of config

DESIGNED_CONFIG = ConfigType.DESIGNED_CONFIG

CONFIG_TYPE_DESIGNED_CONFIG uninitialized value

RUNNING_CONFIG = ConfigType.RUNNING_CONFIG

CONFIG_TYPE_RUNNING_CONFIG uninitialized value

UNSPECIFIED = ConfigType.UNSPECIFIED

CONFIG_TYPE_UNSPECIFIED uninitialized value

name: str | None
value: int
class cloudvision.api.arista.configstatus.v1.Configuration(key: ~cloudvision.api.arista.configstatus.v1.ConfigKey = <PLACEHOLDER>, uri: str | None = <PLACEHOLDER>)[source]

Bases: Message

Configuration represents device’s CLI configuration

key: ConfigKey = <PLACEHOLDER>

key specifies the device and type of config

uri: str | None = <PLACEHOLDER>

uri represents the HTTP URI client can use to GET config body and associated errors

class cloudvision.api.arista.configstatus.v1.ConfigurationBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Configuration')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[Configuration] = <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 Configuration at end. * Each Configuration response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.ConfigurationBatchedStreamResponse(responses: List[ForwardRef('ConfigurationStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[ConfigurationStreamResponse] = <PLACEHOLDER>

Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.configstatus.v1.ConfigurationRequest(key: 'ConfigKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigKey = <PLACEHOLDER>

Key uniquely identifies a Configuration 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.configstatus.v1.ConfigurationResponse(value: 'Configuration' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the Configuration instance in this response.

value: Configuration = <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.configstatus.v1.ConfigurationServiceBase[source]

Bases: ServiceBase

async get_all(configuration_stream_request: ConfigurationStreamRequest) AsyncIterator[ConfigurationStreamResponse][source]
async get_all_batched(configuration_batched_stream_request: ConfigurationBatchedStreamRequest) AsyncIterator[ConfigurationBatchedStreamResponse][source]
async get_meta(configuration_stream_request: ConfigurationStreamRequest) MetaResponse[source]
async get_one(configuration_request: ConfigurationRequest) ConfigurationResponse[source]
async get_some(configuration_some_request: ConfigurationSomeRequest) AsyncIterator[ConfigurationSomeResponse][source]
async subscribe(configuration_stream_request: ConfigurationStreamRequest) AsyncIterator[ConfigurationStreamResponse][source]
async subscribe_batched(configuration_batched_stream_request: ConfigurationBatchedStreamRequest) AsyncIterator[ConfigurationBatchedStreamResponse][source]
async subscribe_meta(configuration_stream_request: ConfigurationStreamRequest) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.ConfigurationServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(configuration_stream_request: ConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigurationStreamResponse][source]
async get_all_batched(configuration_batched_stream_request: ConfigurationBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigurationBatchedStreamResponse][source]
async get_meta(configuration_stream_request: ConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) MetaResponse[source]
async get_one(configuration_request: ConfigurationRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) ConfigurationResponse[source]
async get_some(configuration_some_request: ConfigurationSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigurationSomeResponse][source]
async subscribe(configuration_stream_request: ConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigurationStreamResponse][source]
async subscribe_batched(configuration_batched_stream_request: ConfigurationBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[ConfigurationBatchedStreamResponse][source]
async subscribe_meta(configuration_stream_request: ConfigurationStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.ConfigurationSomeRequest(keys: List[ForwardRef('ConfigKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ConfigKey] = <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.configstatus.v1.ConfigurationSomeResponse(value: 'Configuration' = <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>

Time carries the (UTC) timestamp of the last-modification of the Configuration instance in this response.

value: Configuration = <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.configstatus.v1.ConfigurationStreamRequest(partial_eq_filter: List[ForwardRef('Configuration')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Configuration] = <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 Configuration at end. * Each Configuration response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.ConfigurationStreamResponse(value: 'Configuration' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the Configuration 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: Configuration = <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.configstatus.v1.DiffEntries(values: ~typing.List[~cloudvision.api.arista.configstatus.v1.DiffEntry] = <PLACEHOLDER>)[source]

Bases: Message

DiffEntries indicates potential multiple lines of config diff

values: List[DiffEntry] = <PLACEHOLDER>

values - list of diff entries

class cloudvision.api.arista.configstatus.v1.DiffEntry(op: ~cloudvision.api.arista.configstatus.v1.DiffOp = <PLACEHOLDER>, a_line_num: int | None = <PLACEHOLDER>, b_line_num: int | None = <PLACEHOLDER>, b_parent_line_num: int | None = <PLACEHOLDER>, a_line: str | None = <PLACEHOLDER>, b_line: str | None = <PLACEHOLDER>, a_filter_code: ~cloudvision.api.arista.configstatus.v1.ConfigFilterCode = <PLACEHOLDER>, b_filter_code: ~cloudvision.api.arista.configstatus.v1.ConfigFilterCode = <PLACEHOLDER>, a_parent_line_num: int | None = <PLACEHOLDER>, is_a_default_command: bool | None = <PLACEHOLDER>)[source]

Bases: Message

DiffEntry represents one entry in a Diff

a_filter_code: ConfigFilterCode = <PLACEHOLDER>

a_filter_code represents the config filter code for the line in A

a_line: str | None = <PLACEHOLDER>

a_line is the content of config line in A

a_line_num: int | None = <PLACEHOLDER>

a_line_num indicates the line number in A where the diff is applied

a_parent_line_num: int | None = <PLACEHOLDER>

a_parent_line_num represents the line number of the parent command in A

b_filter_code: ConfigFilterCode = <PLACEHOLDER>

b_filter_code represents the config filter code for the line in B

b_line: str | None = <PLACEHOLDER>

b_line is the content of config line in B

b_line_num: int | None = <PLACEHOLDER>

b_line_num indicates the line number in B where this diff is applied

b_parent_line_num: int | None = <PLACEHOLDER>

b_parent_line_num represents the line number of the parent command in B

is_a_default_command: bool | None = <PLACEHOLDER>

is_a_default_command indicates that config line in A is a default command that is generated by EOS.

op: DiffOp = <PLACEHOLDER>

op specifies type of diff operation

class cloudvision.api.arista.configstatus.v1.DiffOp(value: int)[source]

Bases: Enum

DiffOp is the operation to a line from one side of diff to get to another

ADD = DiffOp.ADD

DIFF_OP_ADD is an addition of a line from A

CHANGE = DiffOp.CHANGE

DIFF_OP_CHANGE is a modification to a line in A

DELETE = DiffOp.DELETE

DIFF_OP_DELETE is deletion of a line from B

IGNORE = DiffOp.IGNORE

DIFF_OP_IGNORE indicates a line that’s ignored in either A or B. One of a_line_num or b_line_num will be -1

NOP = DiffOp.NOP

DIFF_OP_NOP indicates no change. A and B are identical at this line

UNSPECIFIED = DiffOp.UNSPECIFIED

DIFF_OP_UNSPECIFIED uninitialized

name: str | None
value: int
class cloudvision.api.arista.configstatus.v1.ErrorCode(value: int)[source]

Bases: Enum

ErrorCode indicates warnings and errors produced during computing config

CONFIG_FILTER_ERROR = ErrorCode.CONFIG_FILTER_ERROR

ERROR_CODE_CONFIG_FILTER_ERROR indicates error from partial config management filters

DEVICE_ERROR = ErrorCode.DEVICE_ERROR

ERROR_CODE_DEVICE_ERROR indicates device error

DEVICE_WARNING = ErrorCode.DEVICE_WARNING

ERROR_CODE_DEVICE_WARNING indicates device warning

INTERNAL = ErrorCode.INTERNAL

ERROR_CODE_INTERNAL indicates internal errors

PROPOSED_CONFIG_CHECK = ErrorCode.PROPOSED_CONFIG_CHECK

ERROR_CODE_PROPOSED_CONFIG_CHECK indicates an issue with the content of proposed configuration.

UNREACHABLE_DEVICE = ErrorCode.UNREACHABLE_DEVICE

ERROR_CODE_UNREACHABLE_DEVICE indicates the device cannot be reached

UNSPECIFIED = ErrorCode.UNSPECIFIED

ERROR_CODE_UNSPECIFIED uninitialized value

name: str | None
value: int
class cloudvision.api.arista.configstatus.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.

class cloudvision.api.arista.configstatus.v1.SecurityProfile(key: ~cloudvision.api.arista.configstatus.v1.ConfigKey = <PLACEHOLDER>, config: str | None = <PLACEHOLDER>)[source]

Bases: Message

SecurityProfile holds the EOS configuration for the security profile.

config: str | None = <PLACEHOLDER>

config describes the security profile config body

key: ConfigKey = <PLACEHOLDER>

key uniquely identifies the configuration

class cloudvision.api.arista.configstatus.v1.SecurityProfileBatchedStreamRequest(partial_eq_filter: List[ForwardRef('SecurityProfile')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[SecurityProfile] = <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 SecurityProfile at end. * Each SecurityProfile response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SecurityProfileBatchedStreamResponse(responses: List[ForwardRef('SecurityProfileStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SecurityProfileStreamResponse] = <PLACEHOLDER>

Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.configstatus.v1.SecurityProfileComplianceSummary(sync: ~cloudvision.api.arista.configstatus.v1.ConfigSyncCode = <PLACEHOLDER>, nop_lines: int | None = <PLACEHOLDER>, ignored_lines: int | None = <PLACEHOLDER>, added_lines: int | None = <PLACEHOLDER>, deleted_lines: int | None = <PLACEHOLDER>, changed_lines: int | None = <PLACEHOLDER>, digest: str | None = <PLACEHOLDER>, running_config_update_time: ~datetime.datetime = <PLACEHOLDER>, designed_config_update_time: ~datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

SecurityProfileComplianceSummary holds the compliance summary for security profile configuration.

added_lines: int | None = <PLACEHOLDER>

added_lines is the number of lines with code ADD

changed_lines: int | None = <PLACEHOLDER>

changed_lines is the Number of lines with code CHANGE

deleted_lines: int | None = <PLACEHOLDER>

deleted_lines is the number of lines with code DELETE

designed_config_update_time: datetime = <PLACEHOLDER>

designed_config_update_time is the timestamp at which designed security profile or designed config is updated

digest: str | None = <PLACEHOLDER>

digest is the digest (SHA-256 hash) of the security profile configuration diff

ignored_lines: int | None = <PLACEHOLDER>

ignored_lines is the number of lines with code IGNORE

nop_lines: int | None = <PLACEHOLDER>

nop_lines is the number of lines with code no-operation

running_config_update_time: datetime = <PLACEHOLDER>

running_config_update_time is the timestamp at which running security profile or running config is updated

sync: ConfigSyncCode = <PLACEHOLDER>

sync - sync state of the device

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiff(key: ~cloudvision.api.arista.configstatus.v1.ConfigDiffKey = <PLACEHOLDER>, diff: ~cloudvision.api.arista.configstatus.v1.DiffEntries = <PLACEHOLDER>)[source]

Bases: Message

SecurityProfileDiff holds the security profile configuration diff.

diff: DiffEntries = <PLACEHOLDER>

diff represents diff entries

key: ConfigDiffKey = <PLACEHOLDER>

key represents security profile config diff key

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffBatchedStreamRequest(partial_eq_filter: List[ForwardRef('SecurityProfileDiff')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[SecurityProfileDiff] = <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 SecurityProfileDiff at end. * Each SecurityProfileDiff response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffBatchedStreamResponse(responses: List[ForwardRef('SecurityProfileDiffStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SecurityProfileDiffStreamResponse] = <PLACEHOLDER>

Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffRequest(key: 'ConfigDiffKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigDiffKey = <PLACEHOLDER>

Key uniquely identifies a SecurityProfileDiff 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.configstatus.v1.SecurityProfileDiffResponse(value: 'SecurityProfileDiff' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the SecurityProfileDiff instance in this response.

value: SecurityProfileDiff = <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.configstatus.v1.SecurityProfileDiffServiceBase[source]

Bases: ServiceBase

async get_all(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest) AsyncIterator[SecurityProfileDiffStreamResponse][source]
async get_all_batched(security_profile_diff_batched_stream_request: SecurityProfileDiffBatchedStreamRequest) AsyncIterator[SecurityProfileDiffBatchedStreamResponse][source]
async get_meta(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest) MetaResponse[source]
async get_one(security_profile_diff_request: SecurityProfileDiffRequest) SecurityProfileDiffResponse[source]
async get_some(security_profile_diff_some_request: SecurityProfileDiffSomeRequest) AsyncIterator[SecurityProfileDiffSomeResponse][source]
async subscribe(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest) AsyncIterator[SecurityProfileDiffStreamResponse][source]
async subscribe_batched(security_profile_diff_batched_stream_request: SecurityProfileDiffBatchedStreamRequest) AsyncIterator[SecurityProfileDiffBatchedStreamResponse][source]
async subscribe_meta(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffStreamResponse][source]
async get_all_batched(security_profile_diff_batched_stream_request: SecurityProfileDiffBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffBatchedStreamResponse][source]
async get_meta(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) MetaResponse[source]
async get_one(security_profile_diff_request: SecurityProfileDiffRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) SecurityProfileDiffResponse[source]
async get_some(security_profile_diff_some_request: SecurityProfileDiffSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffSomeResponse][source]
async subscribe(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffStreamResponse][source]
async subscribe_batched(security_profile_diff_batched_stream_request: SecurityProfileDiffBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffBatchedStreamResponse][source]
async subscribe_meta(security_profile_diff_stream_request: SecurityProfileDiffStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSomeRequest(keys: List[ForwardRef('ConfigDiffKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ConfigDiffKey] = <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.configstatus.v1.SecurityProfileDiffSomeResponse(value: 'SecurityProfileDiff' = <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>

Time carries the (UTC) timestamp of the last-modification of the SecurityProfileDiff instance in this response.

value: SecurityProfileDiff = <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.configstatus.v1.SecurityProfileDiffStreamRequest(partial_eq_filter: List[ForwardRef('SecurityProfileDiff')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[SecurityProfileDiff] = <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 SecurityProfileDiff at end. * Each SecurityProfileDiff response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffStreamResponse(value: 'SecurityProfileDiff' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the SecurityProfileDiff 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: SecurityProfileDiff = <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.configstatus.v1.SecurityProfileDiffSummary(key: ~cloudvision.api.arista.configstatus.v1.SummaryKey = <PLACEHOLDER>, summary: ~cloudvision.api.arista.configstatus.v1.SecurityProfileComplianceSummary = <PLACEHOLDER>)[source]

Bases: Message

SecurityProfileDiffSummary holds device compliance summary w.r.t security profile.

key: SummaryKey = <PLACEHOLDER>

key uniquely identifies the Summary

summary: SecurityProfileComplianceSummary = <PLACEHOLDER>

summary is the security profile configuration compliance summary

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSummaryBatchedStreamRequest(partial_eq_filter: List[ForwardRef('SecurityProfileDiffSummary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[SecurityProfileDiffSummary] = <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 SecurityProfileDiffSummary at end. * Each SecurityProfileDiffSummary response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSummaryBatchedStreamResponse(responses: List[ForwardRef('SecurityProfileDiffSummaryStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SecurityProfileDiffSummaryStreamResponse] = <PLACEHOLDER>

Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSummaryRequest(key: 'SummaryKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: SummaryKey = <PLACEHOLDER>

Key uniquely identifies a SecurityProfileDiffSummary 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.configstatus.v1.SecurityProfileDiffSummaryResponse(value: 'SecurityProfileDiffSummary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the SecurityProfileDiffSummary instance in this response.

value: SecurityProfileDiffSummary = <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.configstatus.v1.SecurityProfileDiffSummaryServiceBase[source]

Bases: ServiceBase

async get_all(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest) AsyncIterator[SecurityProfileDiffSummaryStreamResponse][source]
async get_all_batched(security_profile_diff_summary_batched_stream_request: SecurityProfileDiffSummaryBatchedStreamRequest) AsyncIterator[SecurityProfileDiffSummaryBatchedStreamResponse][source]
async get_meta(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest) MetaResponse[source]
async get_one(security_profile_diff_summary_request: SecurityProfileDiffSummaryRequest) SecurityProfileDiffSummaryResponse[source]
async get_some(security_profile_diff_summary_some_request: SecurityProfileDiffSummarySomeRequest) AsyncIterator[SecurityProfileDiffSummarySomeResponse][source]
async subscribe(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest) AsyncIterator[SecurityProfileDiffSummaryStreamResponse][source]
async subscribe_batched(security_profile_diff_summary_batched_stream_request: SecurityProfileDiffSummaryBatchedStreamRequest) AsyncIterator[SecurityProfileDiffSummaryBatchedStreamResponse][source]
async subscribe_meta(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSummaryServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffSummaryStreamResponse][source]
async get_all_batched(security_profile_diff_summary_batched_stream_request: SecurityProfileDiffSummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffSummaryBatchedStreamResponse][source]
async get_meta(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) MetaResponse[source]
async get_one(security_profile_diff_summary_request: SecurityProfileDiffSummaryRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) SecurityProfileDiffSummaryResponse[source]
async get_some(security_profile_diff_summary_some_request: SecurityProfileDiffSummarySomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffSummarySomeResponse][source]
async subscribe(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffSummaryStreamResponse][source]
async subscribe_batched(security_profile_diff_summary_batched_stream_request: SecurityProfileDiffSummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileDiffSummaryBatchedStreamResponse][source]
async subscribe_meta(security_profile_diff_summary_stream_request: SecurityProfileDiffSummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSummarySomeRequest(keys: List[ForwardRef('SummaryKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[SummaryKey] = <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.configstatus.v1.SecurityProfileDiffSummarySomeResponse(value: 'SecurityProfileDiffSummary' = <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>

Time carries the (UTC) timestamp of the last-modification of the SecurityProfileDiffSummary instance in this response.

value: SecurityProfileDiffSummary = <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.configstatus.v1.SecurityProfileDiffSummaryStreamRequest(partial_eq_filter: List[ForwardRef('SecurityProfileDiffSummary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[SecurityProfileDiffSummary] = <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 SecurityProfileDiffSummary at end. * Each SecurityProfileDiffSummary response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SecurityProfileDiffSummaryStreamResponse(value: 'SecurityProfileDiffSummary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the SecurityProfileDiffSummary 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: SecurityProfileDiffSummary = <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.configstatus.v1.SecurityProfileRequest(key: 'ConfigKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ConfigKey = <PLACEHOLDER>

Key uniquely identifies a SecurityProfile 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.configstatus.v1.SecurityProfileResponse(value: 'SecurityProfile' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the SecurityProfile instance in this response.

value: SecurityProfile = <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.configstatus.v1.SecurityProfileServiceBase[source]

Bases: ServiceBase

async get_all(security_profile_stream_request: SecurityProfileStreamRequest) AsyncIterator[SecurityProfileStreamResponse][source]
async get_all_batched(security_profile_batched_stream_request: SecurityProfileBatchedStreamRequest) AsyncIterator[SecurityProfileBatchedStreamResponse][source]
async get_meta(security_profile_stream_request: SecurityProfileStreamRequest) MetaResponse[source]
async get_one(security_profile_request: SecurityProfileRequest) SecurityProfileResponse[source]
async get_some(security_profile_some_request: SecurityProfileSomeRequest) AsyncIterator[SecurityProfileSomeResponse][source]
async subscribe(security_profile_stream_request: SecurityProfileStreamRequest) AsyncIterator[SecurityProfileStreamResponse][source]
async subscribe_batched(security_profile_batched_stream_request: SecurityProfileBatchedStreamRequest) AsyncIterator[SecurityProfileBatchedStreamResponse][source]
async subscribe_meta(security_profile_stream_request: SecurityProfileStreamRequest) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SecurityProfileServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(security_profile_stream_request: SecurityProfileStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileStreamResponse][source]
async get_all_batched(security_profile_batched_stream_request: SecurityProfileBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileBatchedStreamResponse][source]
async get_meta(security_profile_stream_request: SecurityProfileStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) MetaResponse[source]
async get_one(security_profile_request: SecurityProfileRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) SecurityProfileResponse[source]
async get_some(security_profile_some_request: SecurityProfileSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileSomeResponse][source]
async subscribe(security_profile_stream_request: SecurityProfileStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileStreamResponse][source]
async subscribe_batched(security_profile_batched_stream_request: SecurityProfileBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SecurityProfileBatchedStreamResponse][source]
async subscribe_meta(security_profile_stream_request: SecurityProfileStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SecurityProfileSomeRequest(keys: List[ForwardRef('ConfigKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[ConfigKey] = <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.configstatus.v1.SecurityProfileSomeResponse(value: 'SecurityProfile' = <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>

Time carries the (UTC) timestamp of the last-modification of the SecurityProfile instance in this response.

value: SecurityProfile = <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.configstatus.v1.SecurityProfileStreamRequest(partial_eq_filter: List[ForwardRef('SecurityProfile')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[SecurityProfile] = <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 SecurityProfile at end. * Each SecurityProfile response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SecurityProfileStreamResponse(value: 'SecurityProfile' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the SecurityProfile 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: SecurityProfile = <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.configstatus.v1.Summary(key: ~cloudvision.api.arista.configstatus.v1.SummaryKey = <PLACEHOLDER>, summary: ~cloudvision.api.arista.configstatus.v1.ConfigSummary = <PLACEHOLDER>)[source]

Bases: Message

Summary - Describes the device’s diff summary

key: SummaryKey = <PLACEHOLDER>

key spefies the device

summary: ConfigSummary = <PLACEHOLDER>

summary - diff summary of the device

class cloudvision.api.arista.configstatus.v1.SummaryBatchedStreamRequest(partial_eq_filter: List[ForwardRef('Summary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>, max_messages: int | None = <PLACEHOLDER>)[source]

Bases: Message

max_messages: int | None = <PLACEHOLDER>

MaxMessages limits the maximum number of messages that can be contained in one batch. MaxMessages is required to be at least 1. The maximum number of messages in a batch is min(max_messages, INTERNAL_BATCH_LIMIT) INTERNAL_BATCH_LIMIT is set based on the maximum message size.

partial_eq_filter: List[Summary] = <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 Summary at end. * Each Summary response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SummaryBatchedStreamResponse(responses: List[ForwardRef('SummaryStreamResponse')] = <PLACEHOLDER>)[source]

Bases: Message

responses: List[SummaryStreamResponse] = <PLACEHOLDER>

Values are the values deemed relevant to the initiating request. The length of this structure is guaranteed to be between (inclusive) 1 and min(req.max_messages, INTERNAL_BATCH_LIMIT).

class cloudvision.api.arista.configstatus.v1.SummaryKey(device_id: str | None = <PLACEHOLDER>)[source]

Bases: Message

SummaryKey uniquely identifies a device summary request

device_id: str | None = <PLACEHOLDER>

device_id is the serial number of the device

class cloudvision.api.arista.configstatus.v1.SummaryRequest(key: 'SummaryKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: SummaryKey = <PLACEHOLDER>

Key uniquely identifies a Summary 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.configstatus.v1.SummaryResponse(value: 'Summary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

Time carries the (UTC) timestamp of the last-modification of the Summary instance in this response.

value: Summary = <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.configstatus.v1.SummaryServiceBase[source]

Bases: ServiceBase

async get_all(summary_stream_request: SummaryStreamRequest) AsyncIterator[SummaryStreamResponse][source]
async get_all_batched(summary_batched_stream_request: SummaryBatchedStreamRequest) AsyncIterator[SummaryBatchedStreamResponse][source]
async get_meta(summary_stream_request: SummaryStreamRequest) MetaResponse[source]
async get_one(summary_request: SummaryRequest) SummaryResponse[source]
async get_some(summary_some_request: SummarySomeRequest) AsyncIterator[SummarySomeResponse][source]
async subscribe(summary_stream_request: SummaryStreamRequest) AsyncIterator[SummaryStreamResponse][source]
async subscribe_batched(summary_batched_stream_request: SummaryBatchedStreamRequest) AsyncIterator[SummaryBatchedStreamResponse][source]
async subscribe_meta(summary_stream_request: SummaryStreamRequest) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SummaryServiceStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)[source]

Bases: ServiceStub

async get_all(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SummaryStreamResponse][source]
async get_all_batched(summary_batched_stream_request: SummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SummaryBatchedStreamResponse][source]
async get_meta(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) MetaResponse[source]
async get_one(summary_request: SummaryRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) SummaryResponse[source]
async get_some(summary_some_request: SummarySomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SummarySomeResponse][source]
async subscribe(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SummaryStreamResponse][source]
async subscribe_batched(summary_batched_stream_request: SummaryBatchedStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[SummaryBatchedStreamResponse][source]
async subscribe_meta(summary_stream_request: SummaryStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) AsyncIterator[MetaResponse][source]
class cloudvision.api.arista.configstatus.v1.SummarySomeRequest(keys: List[ForwardRef('SummaryKey')] = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

keys: List[SummaryKey] = <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.configstatus.v1.SummarySomeResponse(value: 'Summary' = <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>

Time carries the (UTC) timestamp of the last-modification of the Summary instance in this response.

value: Summary = <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.configstatus.v1.SummaryStreamRequest(partial_eq_filter: List[ForwardRef('Summary')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[Summary] = <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 Summary at end. * Each Summary response is fully-specified (all fields set).

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

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

    be partial.

class cloudvision.api.arista.configstatus.v1.SummaryStreamResponse(value: 'Summary' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>, type: '__subscriptions__.Operation' = <PLACEHOLDER>)[source]

Bases: Message

time: datetime = <PLACEHOLDER>

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

type: __subscriptions__.Operation = <PLACEHOLDER>

Operation indicates how the Summary 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: Summary = <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.