cloudvision.api.arista.syslog.v1 package

Module contents

class cloudvision.api.arista.syslog.v1.Export(key: ~cloudvision.api.arista.syslog.v1.ExportKey = <PLACEHOLDER>, stats: ~cloudvision.api.arista.syslog.v1.ExportStats = <PLACEHOLDER>, last_error: ~cloudvision.api.arista.syslog.v1.ExportError = <PLACEHOLDER>, last_success: ~cloudvision.api.arista.syslog.v1.ExportSuccess = <PLACEHOLDER>)[source]

Bases: Message

Export provides the export status for a syslog server.

key: ExportKey = <PLACEHOLDER>: key uniquely identifies a syslog server.

last_error: ExportError = <PLACEHOLDER>: last_error provides the details of the last export error.

last_success: ExportSuccess = <PLACEHOLDER>: last_success provides details of last successful export.

stats: ExportStats = <PLACEHOLDER>: stats contains the statistics for all export operations.

class cloudvision.api.arista.syslog.v1.ExportConfig(key: ~cloudvision.api.arista.syslog.v1.ExportKey = <PLACEHOLDER>)[source]

Bases: Message

ExportConfig is used to configure a syslog server.

key: ExportKey = <PLACEHOLDER>: key uniquely identifies a syslog server.

class cloudvision.api.arista.syslog.v1.ExportConfigDeleteAllRequest(partial_eq_filter: List[ForwardRef('ExportConfig')] = <PLACEHOLDER>)[source]

Bases: Message

partial_eq_filter: List[ExportConfig] = <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.syslog.v1.ExportConfigDeleteAllResponse(type: '___fmp__.DeleteError' = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, key: 'ExportKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

key: ExportKey = <PLACEHOLDER>: This is the key of the ExportConfig 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.syslog.v1.ExportConfigDeleteRequest(key: 'ExportKey' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.syslog.v1.ExportConfigDeleteResponse(key: 'ExportKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ExportKey = <PLACEHOLDER>: Key echoes back the key of the deleted ExportConfig 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.syslog.v1.ExportConfigDeleteSomeRequest(keys: List[ForwardRef('ExportKey')] = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.syslog.v1.ExportConfigDeleteSomeResponse(key: ~cloudvision.api.arista.syslog.v1.ExportKey = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

ExportConfigDeleteSomeResponse is only sent when there is an error.

error: str = <PLACEHOLDER>

key: ExportKey = <PLACEHOLDER>

class cloudvision.api.arista.syslog.v1.ExportConfigRequest(key: 'ExportKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ExportKey = <PLACEHOLDER>: Key uniquely identifies a ExportConfig 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.syslog.v1.ExportConfigResponse(value: 'ExportConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ExportConfig = <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.syslog.v1.ExportConfigServiceBase[source]

Bases: ServiceBase

async delete(export_config_delete_request: ExportConfigDeleteRequest) → ExportConfigDeleteResponse[source]

async delete_all(export_config_delete_all_request: ExportConfigDeleteAllRequest) → AsyncIterator[ExportConfigDeleteAllResponse][source]

async delete_some(export_config_delete_some_request: ExportConfigDeleteSomeRequest) → AsyncIterator[ExportConfigDeleteSomeResponse][source]

async get_all(export_config_stream_request: ExportConfigStreamRequest) → AsyncIterator[ExportConfigStreamResponse][source]

async get_meta(export_config_stream_request: ExportConfigStreamRequest) → MetaResponse[source]

async get_one(export_config_request: ExportConfigRequest) → ExportConfigResponse[source]

async get_some(export_config_some_request: ExportConfigSomeRequest) → AsyncIterator[ExportConfigSomeResponse][source]

async set(export_config_set_request: ExportConfigSetRequest) → ExportConfigSetResponse[source]

async set_some(export_config_set_some_request: ExportConfigSetSomeRequest) → AsyncIterator[ExportConfigSetSomeResponse][source]

async subscribe(export_config_stream_request: ExportConfigStreamRequest) → AsyncIterator[ExportConfigStreamResponse][source]

async subscribe_meta(export_config_stream_request: ExportConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(export_config_delete_request: ExportConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ExportConfigDeleteResponse[source]

async delete_all(export_config_delete_all_request: ExportConfigDeleteAllRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportConfigDeleteAllResponse][source]

async delete_some(export_config_delete_some_request: ExportConfigDeleteSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportConfigDeleteSomeResponse][source]

async get_all(export_config_stream_request: ExportConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportConfigStreamResponse][source]

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

async get_one(export_config_request: ExportConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ExportConfigResponse[source]

async get_some(export_config_some_request: ExportConfigSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportConfigSomeResponse][source]

async set(export_config_set_request: ExportConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ExportConfigSetResponse[source]

async set_some(export_config_set_some_request: ExportConfigSetSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportConfigSetSomeResponse][source]

async subscribe(export_config_stream_request: ExportConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportConfigStreamResponse][source]

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

class cloudvision.api.arista.syslog.v1.ExportConfigSetRequest(value: 'ExportConfig' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.syslog.v1.ExportConfigSetResponse(value: 'ExportConfig' = <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: ExportConfig = <PLACEHOLDER>: Value carries all the values given in the ExportConfigSetRequest as well as any server-generated values.

class cloudvision.api.arista.syslog.v1.ExportConfigSetSomeRequest(values: List[ForwardRef('ExportConfig')] = <PLACEHOLDER>)[source]

Bases: Message

values: List[ExportConfig] = <PLACEHOLDER>

value contains a list of ExportConfig 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.syslog.v1.ExportConfigSetSomeResponse(key: 'ExportKey' = <PLACEHOLDER>, error: str = <PLACEHOLDER>)[source]

Bases: Message

error: str = <PLACEHOLDER>

key: ExportKey = <PLACEHOLDER>

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

Bases: Message

keys: List[ExportKey] = <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.syslog.v1.ExportConfigSomeResponse(value: 'ExportConfig' = <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 ExportConfig instance in this response.

value: ExportConfig = <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.syslog.v1.ExportConfigStreamRequest(partial_eq_filter: List[ForwardRef('ExportConfig')] = <PLACEHOLDER>, time: '__time__.TimeBounds' = <PLACEHOLDER>)[source]

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ExportConfig 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: ExportConfig = <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.syslog.v1.ExportError(timestamp: ~datetime.datetime = <PLACEHOLDER>, error: str | None = <PLACEHOLDER>, detail: str | None = <PLACEHOLDER>, log_timestamp: ~datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

ExportError provides the details of the most recent export error.

detail: str | None = <PLACEHOLDER>: detail indicates the audit log that was not exported.

error: str | None = <PLACEHOLDER>: error indicates the export error.

log_timestamp: datetime = <PLACEHOLDER>: log_timestamp provides the timestamp of the last audit log that was not exported due to error.

timestamp: datetime = <PLACEHOLDER>: timestamp provides the timestamp of the export error.

class cloudvision.api.arista.syslog.v1.ExportFormatConfig(format: ~cloudvision.api.arista.syslog.v1.Format = <PLACEHOLDER>)[source]

Bases: Message

ExportFormatConfig is used to confgure a global format for exporting logs to all the configured syslog servers.

format: Format = <PLACEHOLDER>: format defines the syslog format to be used for export.

class cloudvision.api.arista.syslog.v1.ExportFormatConfigRequest(time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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.syslog.v1.ExportFormatConfigResponse(value: 'ExportFormatConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ExportFormatConfig = <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.syslog.v1.ExportFormatConfigServiceBase[source]

Bases: ServiceBase

async get_all(export_format_config_stream_request: ExportFormatConfigStreamRequest) → AsyncIterator[ExportFormatConfigStreamResponse][source]

async get_one(export_format_config_request: ExportFormatConfigRequest) → ExportFormatConfigResponse[source]

async set(export_format_config_set_request: ExportFormatConfigSetRequest) → ExportFormatConfigSetResponse[source]

async subscribe(export_format_config_stream_request: ExportFormatConfigStreamRequest) → AsyncIterator[ExportFormatConfigStreamResponse][source]

async subscribe_meta(export_format_config_stream_request: ExportFormatConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(export_format_config_stream_request: ExportFormatConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportFormatConfigStreamResponse][source]

async get_one(export_format_config_request: ExportFormatConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ExportFormatConfigResponse[source]

async set(export_format_config_set_request: ExportFormatConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ExportFormatConfigSetResponse[source]

async subscribe(export_format_config_stream_request: ExportFormatConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportFormatConfigStreamResponse][source]

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

class cloudvision.api.arista.syslog.v1.ExportFormatConfigSetRequest(value: 'ExportFormatConfig' = <PLACEHOLDER>)[source]

Bases: Message

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

class cloudvision.api.arista.syslog.v1.ExportFormatConfigSetResponse(value: 'ExportFormatConfig' = <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: ExportFormatConfig = <PLACEHOLDER>: Value carries all the values given in the ExportFormatConfigSetRequest as well as any server-generated values.

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

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the ExportFormatConfig 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: ExportFormatConfig = <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.syslog.v1.ExportKey(hostname_or_ip: str | None = <PLACEHOLDER>, port_num: ~cloudvision.api.fmp.Port = <PLACEHOLDER>, protocol: ~cloudvision.api.arista.syslog.v1.TransportProtocol = <PLACEHOLDER>)[source]

Bases: Message

ExportKey uniquely identifies a syslog server to which to export logs.

hostname_or_ip: str | None = <PLACEHOLDER>: hostname_or_ip is the IP address or hostname of the syslog server.

port_num: ___fmp__.Port = <PLACEHOLDER>: port_num is the destination port number of the syslog server.

protocol: TransportProtocol = <PLACEHOLDER>: protocol defines the transport protocol for the syslog export.

class cloudvision.api.arista.syslog.v1.ExportRequest(key: 'ExportKey' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

key: ExportKey = <PLACEHOLDER>: Key uniquely identifies a Export 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.syslog.v1.ExportResponse(value: 'Export' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: Export = <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.syslog.v1.ExportResult(value: int)[source]

Bases: Enum

ExportResult defines the set of possible results of an export operation.

FAILURE = ExportResult.FAILURE: EXPORT_RESULT_FAILURE indicates an unsuccessful export operation.

SUCCESS = ExportResult.SUCCESS: EXPORT_RESULT_SUCCESS indicates a successful export operation.

UNSPECIFIED = ExportResult.UNSPECIFIED: EXPORT_RESULT_UNSPECIFIED indicates unspecified export operation.

name: str | None

value: int

class cloudvision.api.arista.syslog.v1.ExportServiceBase[source]

Bases: ServiceBase

async get_all(export_stream_request: ExportStreamRequest) → AsyncIterator[ExportStreamResponse][source]

async get_meta(export_stream_request: ExportStreamRequest) → MetaResponse[source]

async get_one(export_request: ExportRequest) → ExportResponse[source]

async get_some(export_some_request: ExportSomeRequest) → AsyncIterator[ExportSomeResponse][source]

async subscribe(export_stream_request: ExportStreamRequest) → AsyncIterator[ExportStreamResponse][source]

async subscribe_meta(export_stream_request: ExportStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(export_stream_request: ExportStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportStreamResponse][source]

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

async get_one(export_request: ExportRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ExportResponse[source]

async get_some(export_some_request: ExportSomeRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportSomeResponse][source]

async subscribe(export_stream_request: ExportStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ExportStreamResponse][source]

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

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

Bases: Message

keys: List[ExportKey] = <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.syslog.v1.ExportSomeResponse(value: 'Export' = <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 Export instance in this response.

value: Export = <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.syslog.v1.ExportStats(num_success: int | None = <PLACEHOLDER>, num_errors: int | None = <PLACEHOLDER>, last_result: ~cloudvision.api.arista.syslog.v1.ExportResult = <PLACEHOLDER>)[source]

Bases: Message

ExportStats provide statistics of export operations to a syslog sever.

last_result: ExportResult = <PLACEHOLDER>: last_result provides the status of the last export operation.

num_errors: int | None = <PLACEHOLDER>: num_errors indicates the count of export errors.

num_success: int | None = <PLACEHOLDER>: num_success indicates the count of successful exports.

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

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: __subscriptions__.Operation = <PLACEHOLDER>: Operation indicates how the Export 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: Export = <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.syslog.v1.ExportSuccess(timestamp: ~datetime.datetime = <PLACEHOLDER>, log_timestamp: ~datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

ExportSuccess provides the details of the last successful export operation.

log_timestamp: datetime = <PLACEHOLDER>: log_timestamp provides the timestamp of the last successful audit log.

timestamp: datetime = <PLACEHOLDER>: timestamp provides the timestamp of last successful export opeartion.

class cloudvision.api.arista.syslog.v1.Format(value: int)[source]

Bases: Enum

Format defines the set of formats to be used for export to syslog servers.

CUSTOM = Format.CUSTOM: FORMAT_CUSTOM indicates a native custom format with a UTC timestamp.

RFC3164 = Format.RFC3164: FORMAT_RFC3164 indicates the BSD syslog protocol as defined by RFC 3164.

RFC5424 = Format.RFC5424: FORMAT_RFC5424 indicates the IETF syslog protocol as defined by RFC 5424.

UNSPECIFIED = Format.UNSPECIFIED: FORMAT_UNSPECIFIED indicates unspecified format.

name: str | None

value: int

class cloudvision.api.arista.syslog.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.syslog.v1.TransportProtocol(value: int)[source]

Bases: Enum

TransportProtocol defines the set of transport protocols to be used for export.

TCP = TransportProtocol.TCP: TRANSPORT_PROTOCOL_TCP indicates the TCP over TLS protocol.

UDP = TransportProtocol.UDP: TRANSPORT_PROTOCOL_UDP indicates the User Datagram Protocol (UDP).

UNSPECIFIED = TransportProtocol.UNSPECIFIED: TRANSPORT_PROTOCOL_UNSPECIFIED indicates unspecified protocol.

name: str | None

value: int