cloudvision.api.arista.arista_portal.v1 package

Module contents

class cloudvision.api.arista.arista_portal.v1.ApiProxy(url: str | None = <PLACEHOLDER>)[source]

Bases: Message

APIProxy is the state model that displays the proxy url string value set and found on the CloudVision instance.

APIProxy Methods:

The GetOne method is used to return a proxy with username and password obscured that has been set within CloudVision.

Retrieving a proxy:

The proxy can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a proxy being retrieved

` GetOne(APIProxy{ }) `

NOTE: Proxy configuration is not applicable to CloudVision-as-a-Service. - If a proxy contains a username and/or password, it will be returned with the credentials censored.

url: str | None = <PLACEHOLDER>: url is the proxy URL string

class cloudvision.api.arista.arista_portal.v1.ApiProxyConfig(url: str | None = <PLACEHOLDER>)[source]

Bases: Message

APIProxyConfig is the config model allowing users to set and delete the proxy value which is used in retrieving resources from arista.com.

APIProxyConfig Methods:

The Set method is used to add and/or modify a proxy stored in CloudVision. The Delete method is used to remove said proxy. The GetOne method is used to return a proxy with username and password obscured that has been set within CloudVision.

Adding a proxy to CloudVision:

When a Set is called, the rAPI will first ensure this proxy is valid after which it will stored within CloudVision.

Here is an example of a proxy value being set

``` Set(APIProxyConfig{

Url: “http://10.0.0.0:0”

})

Deleting a proxy:

The proxy configuration can be removed from CloudVision by calling Delete.

Here is an example of a proxy being deleted

` Delete(APIProxyConfig{ }) `

Retrieving a proxy:

The proxy can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a proxy being retrieved

` GetOne(APIProxyConfig{ }) `

NOTE: Proxy configuration is not applicable to CloudVision-as-a-Service. - If a proxy contains a username and/or password, it will be returned with the credentials censored.

url: str | None = <PLACEHOLDER>: url is the proxy URL string

class cloudvision.api.arista.arista_portal.v1.ApiProxyConfigDeleteRequest[source]: Bases: Message

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

Bases: Message

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.arista_portal.v1.ApiProxyConfigRequest(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.arista_portal.v1.ApiProxyConfigResponse(value: 'ApiProxyConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ApiProxyConfig = <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.arista_portal.v1.ApiProxyConfigServiceBase[source]

Bases: ServiceBase

async delete(api_proxy_config_delete_request: ApiProxyConfigDeleteRequest) → ApiProxyConfigDeleteResponse[source]

async get_all(api_proxy_config_stream_request: ApiProxyConfigStreamRequest) → AsyncIterator[ApiProxyConfigStreamResponse][source]

async get_one(api_proxy_config_request: ApiProxyConfigRequest) → ApiProxyConfigResponse[source]

async set(api_proxy_config_set_request: ApiProxyConfigSetRequest) → ApiProxyConfigSetResponse[source]

async subscribe(api_proxy_config_stream_request: ApiProxyConfigStreamRequest) → AsyncIterator[ApiProxyConfigStreamResponse][source]

async subscribe_meta(api_proxy_config_stream_request: ApiProxyConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(api_proxy_config_delete_request: ApiProxyConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiProxyConfigDeleteResponse[source]

async get_all(api_proxy_config_stream_request: ApiProxyConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiProxyConfigStreamResponse][source]

async get_one(api_proxy_config_request: ApiProxyConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiProxyConfigResponse[source]

async set(api_proxy_config_set_request: ApiProxyConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiProxyConfigSetResponse[source]

async subscribe(api_proxy_config_stream_request: ApiProxyConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiProxyConfigStreamResponse][source]

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

class cloudvision.api.arista.arista_portal.v1.ApiProxyConfigSetRequest(value: 'ApiProxyConfig' = <PLACEHOLDER>)[source]

Bases: Message

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

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

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

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: Operation = <PLACEHOLDER>: Operation indicates how the APIProxyConfig 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: ApiProxyConfig = <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.arista_portal.v1.ApiProxyRequest(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.arista_portal.v1.ApiProxyResponse(value: 'ApiProxy' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ApiProxy = <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.arista_portal.v1.ApiProxyServiceBase[source]

Bases: ServiceBase

async get_all(api_proxy_stream_request: ApiProxyStreamRequest) → AsyncIterator[ApiProxyStreamResponse][source]

async get_one(api_proxy_request: ApiProxyRequest) → ApiProxyResponse[source]

async subscribe(api_proxy_stream_request: ApiProxyStreamRequest) → AsyncIterator[ApiProxyStreamResponse][source]

async subscribe_meta(api_proxy_stream_request: ApiProxyStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(api_proxy_stream_request: ApiProxyStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiProxyStreamResponse][source]

async get_one(api_proxy_request: ApiProxyRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiProxyResponse[source]

async subscribe(api_proxy_stream_request: ApiProxyStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiProxyStreamResponse][source]

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

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

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: Operation = <PLACEHOLDER>: Operation indicates how the APIProxy 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: ApiProxy = <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.arista_portal.v1.ApiToken(token: str | None = <PLACEHOLDER>)[source]

Bases: Message

APIToken is the state model that indicates whether a token is set or not.

APIToken Methods:

The GetOne method is used to determine whether a token is set or not within CloudVision.

Retrieving a token:

The token can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a token being retrieved

` GetOne(APIToken{ }) `

NOTE: GetOne functionality for APIToken will only display whether a token is currently present or not. No secret values will be returned. The two valid responses are; * “Token is set” * “Token not set”

token: str | None = <PLACEHOLDER>: token is the token string

class cloudvision.api.arista.arista_portal.v1.ApiTokenConfig(token: str | None = <PLACEHOLDER>)[source]

Bases: Message

APITokenConfig is the config model allowing users to modify the token value which is used for a multitude of functionalities, mainly in retrieving resources from arista.com e.g. the AlertBase.json or software images. Without a token set, a user can not retrieve any resources from arista.com NOTE: A user configured token is not required on CloudVision-as-a-Service for AlertBase updates.

APITokenConfig Methods:

The Set method is used to add and/or modify a token stored in CloudVision. The Delete method is used to remove the token. The GetOne method is used to determine whether a token is set or not on CloudVision.

Adding a token to CloudVision:

When a Set is called, the rAPI will first ensure the token is valid and in the correct format after which it will stored within CloudVision.

Here is an example of a token value being set

``` Set(APITokenConfig{

Token: “f7f898e3860f618301c01f2de1ao1482”

})

Deleting a token:

The token can be removed from CloudVision by calling Delete.

Here is an example of a token being deleted

` Delete(APITokenConfig{ }) `

Retrieving a token:

The token can be retrieved from CloudVision by calling the GetOne method.

Here is an example of a token being retrieved

` GetOne(APITokenConfig{ }) `

NOTE: GetOne functionality for APITokenConfig will only display whether a token is currently present or not. No secret values will be returned. The two valid responses are; * “Token is set” * “Token not set”

token: str | None = <PLACEHOLDER>: token is the token string

class cloudvision.api.arista.arista_portal.v1.ApiTokenConfigDeleteRequest[source]: Bases: Message

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

Bases: Message

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.arista_portal.v1.ApiTokenConfigRequest(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.arista_portal.v1.ApiTokenConfigResponse(value: 'ApiTokenConfig' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ApiTokenConfig = <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.arista_portal.v1.ApiTokenConfigServiceBase[source]

Bases: ServiceBase

async delete(api_token_config_delete_request: ApiTokenConfigDeleteRequest) → ApiTokenConfigDeleteResponse[source]

async get_all(api_token_config_stream_request: ApiTokenConfigStreamRequest) → AsyncIterator[ApiTokenConfigStreamResponse][source]

async get_one(api_token_config_request: ApiTokenConfigRequest) → ApiTokenConfigResponse[source]

async set(api_token_config_set_request: ApiTokenConfigSetRequest) → ApiTokenConfigSetResponse[source]

async subscribe(api_token_config_stream_request: ApiTokenConfigStreamRequest) → AsyncIterator[ApiTokenConfigStreamResponse][source]

async subscribe_meta(api_token_config_stream_request: ApiTokenConfigStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async delete(api_token_config_delete_request: ApiTokenConfigDeleteRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiTokenConfigDeleteResponse[source]

async get_all(api_token_config_stream_request: ApiTokenConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiTokenConfigStreamResponse][source]

async get_one(api_token_config_request: ApiTokenConfigRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiTokenConfigResponse[source]

async set(api_token_config_set_request: ApiTokenConfigSetRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiTokenConfigSetResponse[source]

async subscribe(api_token_config_stream_request: ApiTokenConfigStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiTokenConfigStreamResponse][source]

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

class cloudvision.api.arista.arista_portal.v1.ApiTokenConfigSetRequest(value: 'ApiTokenConfig' = <PLACEHOLDER>)[source]

Bases: Message

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

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

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

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: Operation = <PLACEHOLDER>: Operation indicates how the APITokenConfig 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: ApiTokenConfig = <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.arista_portal.v1.ApiTokenRequest(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.arista_portal.v1.ApiTokenResponse(value: 'ApiToken' = <PLACEHOLDER>, time: datetime.datetime = <PLACEHOLDER>)[source]

Bases: Message

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

value: ApiToken = <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.arista_portal.v1.ApiTokenServiceBase[source]

Bases: ServiceBase

async get_all(api_token_stream_request: ApiTokenStreamRequest) → AsyncIterator[ApiTokenStreamResponse][source]

async get_one(api_token_request: ApiTokenRequest) → ApiTokenResponse[source]

async subscribe(api_token_stream_request: ApiTokenStreamRequest) → AsyncIterator[ApiTokenStreamResponse][source]

async subscribe_meta(api_token_stream_request: ApiTokenStreamRequest) → AsyncIterator[MetaResponse][source]

Bases: ServiceStub

async get_all(api_token_stream_request: ApiTokenStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiTokenStreamResponse][source]

async get_one(api_token_request: ApiTokenRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ApiTokenResponse[source]

async subscribe(api_token_stream_request: ApiTokenStreamRequest, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[ApiTokenStreamResponse][source]

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

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

Bases: Message

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

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

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

be partial.

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

Bases: Message

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

type: Operation = <PLACEHOLDER>: Operation indicates how the APIToken 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: ApiToken = <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.arista_portal.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: 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.