license.v1
Available Services
ApplicableLicenseBundlesService
LicenseAssignmentConfigService
arista/license.v1/license.proto
ApplicableDevices
ApplicableDevices represents a feature and an applicable device data for the feature. To get this, We take devices from purchaseDevices and Inventory path, extract model for each device, check applicable feature using modelSKUMapping path and if the model has SKU of the requested feature, send it. License information of the device is aggregated from license/deviceLicenseMapping path. Note: This resource is only available in CVaaS.
| Field Name | Type | Description |
|---|---|---|
| key | ApplicableDevicesKey | key uniquely identifies applicable devices. |
| device_licenses_data | DeviceData | device_licenses_data is basic device data with licenses it has. |
ApplicableDevicesKey
ApplicableDevicesKey uniquely identifies an ApplicableDevice for a feature.
| Field Name | Type | Description |
|---|---|---|
| feature | Feature | feature is the name of license feature. |
| device_serial | google.protobuf.StringValue | device_serial is the serial number of the device. |
ApplicableLicenseBundles
ApplicableLicenseBundles represents a list of license bundles that are compatible with a given device for a specific feature. The list may contain a preferred bundle based on a defined priority order. Note: This resource is only available in CVaaS.
| Field Name | Type | Description |
|---|---|---|
| key | ApplicableLicenseBundlesKey | key is the key identifying the bundle request. |
| bundles | RepeatedLicenseBundle | bundles is a list of applicable license bundles. There should be at most one |
ApplicableLicenseBundlesKey
ApplicableLicenseBundlesKey is used to request a list of license bundles applicable to a specific device serial for a given feature. The device's model number derived from the serial is used to determine compatibility and to prioritize bundles.
| Field Name | Type | Description |
|---|---|---|
| feature | Feature | feature is the name of license feature. |
| device_serial | google.protobuf.StringValue | device_serial is the serial number of the device. |
DeviceData
DeviceData represents basic data of the device along with the licenses installed on it.
| Field Name | Type | Description |
|---|---|---|
| serial | google.protobuf.StringValue | serial is the serial number of the device. |
| hostname | google.protobuf.StringValue | hostname is the hostname of the device. |
| sales_order_number | google.protobuf.StringValue | sales_order_number is the sales order of the device. |
| model | google.protobuf.StringValue | model is the model name of the device. |
| platform_classes | fmp.RepeatedString | platform_classes are the supported license platform classes of the device. |
| licenses | RepeatedLicenseInfo | licenses which are already installed on the device. |
| applicable_license_skus | fmp.RepeatedString | applicable_license_skus are the applicable license SKUs for the device of the requested feature. |
DeviceLicenseStatus
DeviceLicenseStatus contains a mapping of assigned devices to license installation state.
| Field Name | Type | Description |
|---|---|---|
| values | DeviceLicenseStatus.ValuesEntry[...] | values is a map of deviceID to installation status. |
DeviceLicenseStatus.ValuesEntry
| Field Name | Type | Description |
|---|---|---|
| key | string | |
| value | LicenseStatus |
Filter
Filter is used to filter devices based on licenses installed on it.
| Field Name | Type | Description |
|---|---|---|
| has_perpetual_license | google.protobuf.BoolValue | has_perpetual_license when set filters devices which has atleast one perpetual license for the given feature. |
LicenseAssignment
LicenseAssignment describes the status of device assignment. Note: This resource is only available in CVaaS.
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | key uniquely identifies a license assignment for the device. |
| license_uuid | google.protobuf.StringValue | license_uuid is a unique id associated with a license. |
| license_file_serial | google.protobuf.StringValue | license_file_serial is unique serial number embedded in the license file. |
| status | AssignmentStatus | status is device assignment status. |
| assign_time | google.protobuf.Timestamp | assign_time is the time when the license is assigned. |
| error | google.protobuf.StringValue | error is an error message for the device assignment failure. |
LicenseAssignmentConfig
LicenseAssignmentConfig describes a device assignment request. "Assignment" refers to associating the purchased license to a device. Note: This resource is only available in CVaaS.
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | key uniquely identifies a license assignment for the device. |
| assigned | google.protobuf.BoolValue | assigned indicates whether the license should be assigned or unassigned. |
LicenseAssignmentKey
LicenseAssignmentKey uniquely identifies a license.
| Field Name | Type | Description |
|---|---|---|
| license_bundle_uuid | google.protobuf.StringValue | license_bundle_uuid is a unique id of the license bundle. |
| device | google.protobuf.StringValue | device is the serial number of the device to which the license should be assigned. |
LicenseBundle
LicenseBundle represents a single license bundle with its UUID and preference status.
| Field Name | Type | Description |
|---|---|---|
| license_bundle_uuid | google.protobuf.StringValue | license_bundle_uuid is a unique id of the license bundle. |
| sales_order_number | google.protobuf.Int64Value | sales_order_number is the sales order number for the purchased license bundle. |
| sku | google.protobuf.StringValue | sku represents the name of the sku which is combination of platform and feature name. Example: LIC-FIX-4-MACSEC |
| plan_name | PlanName | plan_name indicates type of license (perpetual/subscription). |
| start_time | google.protobuf.Timestamp | start_time is the time when the license comes into force. |
| end_time | google.protobuf.Timestamp | end_time is the time when the license expires. |
| total_license_count | google.protobuf.UInt64Value | total_license_count is the total number of licenses purchased in this bundle. |
| unassigned_license_count | google.protobuf.UInt64Value | unassigned_license_count is the number of licenses that are currently unassigned in this bundle. |
| is_preferred | google.protobuf.BoolValue | is_preferred indicates if this bundle is the preferred bundle. |
| preferred_bundle_reason | PreferredBundleReason | preferred_bundle_reason indicates why this bundle is preferred. This field is only populated when is_preferred is true. |
LicenseFile
LicenseFile describes the available license files for installation or uninstallation on the device.
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | key uniquely identifies a license file. |
| version | google.protobuf.StringValue | version is the version number of the license file. |
| customer_name | google.protobuf.StringValue | customer_name is the name of customer who owns this license file. |
| device_license_status | DeviceLicenseStatus | device_license_status contains mapping of assigned. devices to license installation status. |
| feature | Feature | feature is the name of license feature that this license file refers to. |
| start_time | google.protobuf.Timestamp | start_time is the time when the license comes into force. |
| end_time | google.protobuf.Timestamp | end_time is the time when the license expires. |
| source | LicenseSource | source is the means by which the license file was obtained. |
| file_name | google.protobuf.StringValue | file_name is the name of the license file. |
LicenseFileConfig
LicenseFileConfig describes a request to upload and install/uninstall a license file to the assigned device. User can request license installation or uninstallation by setting the installed attribute as true/false in the request.
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | key uniquely identifies a license file. |
| license_file_json | google.protobuf.StringValue | license_file_json is the JSON string of the license file. |
| installed | google.protobuf.BoolValue | installed indicates whether the license file should be installed or uninstalled. |
LicenseFileKey
LicenseFileKey uniquely identifies a license file.
| Field Name | Type | Description |
|---|---|---|
| license_file_serial | google.protobuf.StringValue | license_file_serial is unique serial number embedded in the license file. |
LicenseInfo
LicenseInfo has the start time, end time, grace period and plan name of a license.
| Field Name | Type | Description |
|---|---|---|
| start_time | google.protobuf.Timestamp | start_time is the time when the license starts its effect. |
| end_time | google.protobuf.Timestamp | end_time is the time when the license will be terminated. |
| grace_period | google.protobuf.UInt32Value | grace_period is the number of days a license is valid after expiry. |
| plan_name | PlanName | plan_name indicates type of license (perpetual/subscription). |
LicenseStatus
LicenseStatus contains license installation state and error.
| Field Name | Type | Description |
|---|---|---|
| state | LicenseState | state is the installation status of the license file on the device. |
| error | google.protobuf.StringValue | error indicates the error message for license installation/uninstallation failure. |
PurchasedLicense
PurchasedLicense is a license record derived from the sales order information where each order is expanded into individual licenses. These licenses will be uniquely identified with license_uuid. Note: This resource is only available in CVaaS.
| Field Name | Type | Description |
|---|---|---|
| key | PurchasedLicenseKey | key uniquely identifies a license. |
| assigned_device | google.protobuf.StringValue | assigned_device denotes device serial number to which this license is associated. Initially assigned_device will be nil, it will be updated after device assignment by the user. |
| so_number | google.protobuf.StringValue | so_number is the sales order number for the purchased license. |
| license_bundle_uuid | google.protobuf.StringValue | license_bundle_uuid is a unique id of the license bundle. |
| sku | google.protobuf.StringValue | sku represents the name of the sku which is combination of platform and feature name. Example: LIC-FIX-4-MACSEC |
| feature | Feature | feature is the name of the feature for which the license was purchased. |
| start_time | google.protobuf.Timestamp | start_time is the time when the license comes into force. |
| end_time | google.protobuf.Timestamp | end_time is the time when the license expires. |
| plan_name | PlanName | plan_name indicates type of license (perpetual/ subscription). |
| original_subscription_record_number | google.protobuf.Int64Value | original_subscription_record_number is the parent subscription record number. |
| original_sales_order_number | google.protobuf.Int64Value | original_sales_order_number is the parent sales order number. |
| renewal_status | google.protobuf.StringValue | renewal_status is the renewal status of license. |
| renewal_status_date | google.protobuf.Timestamp | renewal_status_date is the renewal date of license. |
| end_customer_parent_account_id | google.protobuf.Int64Value | end_customer_parent_account_id is the parent company ID. |
| end_customer_parent_account_name | google.protobuf.StringValue | end_customer_parent_account_name is the parent company name. |
| platform_class | google.protobuf.StringValue | platform_class is the platform class of the license sku. |
PurchasedLicenseKey
PurchasedLicenseKey uniquely identifies a license.
| Field Name | Type | Description |
|---|---|---|
| license_uuid | google.protobuf.StringValue | license_uuid is a unique id associated with a license. |
RepeatedLicenseBundle
RepeatedLicenseBundle is a wrapper around LicenseBundle.
| Field Name | Type | Description |
|---|---|---|
| values | LicenseBundle[...] | values store the details of license bundles. |
RepeatedLicenseInfo
RepeatedLicenseInfo is a wrapper around LicenseInfo.
| Field Name | Type | Description |
|---|---|---|
| values | LicenseInfo[...] | values store the details of licenses installed on the devices. |
AssignmentStatus
AssignmentStatus enumerates the set of execution statuses of device assignment.
| Name | Number | Description |
|---|---|---|
| ASSIGNMENT_STATUS_UNSPECIFIED | 0 | ASSIGNMENT_STATUS_UNSPECIFIED refers to unspecified status. |
| ASSIGNMENT_STATUS_ASSIGNMENT_IN_PROGRESS | 1 | ASSIGNMENT_STATUS_ASSIGNMENT_IN_PROGRESS indicates device assignment is in progress. |
| ASSIGNMENT_STATUS_ASSIGNMENT_SUCCESS | 2 | ASSIGNMENT_STATUS_ASSIGNMENT_SUCCESS indicates device assignment succeeded. |
| ASSIGNMENT_STATUS_ASSIGNMENT_FAILURE | 3 | ASSIGNMENT_STATUS_ASSIGNMENT_FAILURE indicates device assignment failed. |
| ASSIGNMENT_STATUS_UNASSIGNMENT_IN_PROGRESS | 4 | ASSIGNMENT_STATUS_UNASSIGNMENT_IN_PROGRESS indicates device unassignment is in progress. |
| ASSIGNMENT_STATUS_UNASSIGNMENT_SUCCESS | 5 | ASSIGNMENT_STATUS_UNASSIGNMENT_SUCCESS indicates device unassignment succeeded. |
| ASSIGNMENT_STATUS_UNASSIGNMENT_FAILURE | 6 | ASSIGNMENT_STATUS_UNASSIGNMENT_FAILURE indicates device unassignment failed. |
Feature
Feature is the name of the feature for which the license was purchased.
| Name | Number | Description |
|---|---|---|
| FEATURE_UNSPECIFIED | 0 | FEATURE_UNSPECIFIED refers to unspecified license feature. |
| FEATURE_IPSEC | 1 | FEATURE_IPSEC refers to the feature IPSEC. |
| FEATURE_MACSEC | 2 | FEATURE_MACSEC refers to the feature MACSEC. |
| FEATURE_ENCR | 3 | FEATURE_ENCR refers to the encryption. |
| FEATURE_CLOUDEOS | 4 | FEATURE_CLOUDEOS refers to the feature CLOUDEOS. |
| FEATURE_CVPATHFINDER | 5 | FEATURE_CVPATHFINDER refers to the feature CVPATHFINDER. |
LicenseScope
LicenseScope indicates the number of devices a license supports.
| Name | Number | Description |
|---|---|---|
| LICENSE_SCOPE_UNSPECIFIED | 0 | LICENSE_SCOPE_UNSPECIFIED indicates an unspecified license scope. |
| LICENSE_SCOPE_SINGLE_DEVICE | 1 | LICENSE_SCOPE_SINGLE_DEVICE indicates a license file that supports a single device. |
| LICENSE_SCOPE_MULTIPLE_DEVICE | 2 | LICENSE_SCOPE_MULTIPLE_DEVICE indicates a license file that supports multiple devices. |
LicenseSource
LicenseSource is the source from where license file has been obtained.
| Name | Number | Description |
|---|---|---|
| LICENSE_SOURCE_UNSPECIFIED | 0 | LICENSE_SOURCE_UNSPECIFIED refers to unspecified license source. |
| LICENSE_SOURCE_USER_UPLOAD | 1 | LICENSE_SOURCE_USER_UPLOAD refers to the license source as uploaded by user through UI. |
| LICENSE_SOURCE_DISCOVERED | 2 | LICENSE_SOURCE_DISCOVERED refers to the license source as being discovered from device where license was manually installed. |
| LICENSE_SOURCE_PROCURED | 3 | LICENSE_SOURCE_PROCURED refers to the license source as being procured from License Request Service. |
LicenseState
LicenseState represents the installation status of a device license file.
| Name | Number | Description |
|---|---|---|
| LICENSE_STATE_UNSPECIFIED | 0 | LICENSE_STATE_UNSPECIFIED indicates an unspecified license state. |
| LICENSE_STATE_INSTALLED | 1 | LICENSE_STATE_INSTALLED indicates the license is installed. |
| LICENSE_STATE_UNINSTALLED | 2 | LICENSE_STATE_UNINSTALLED indicates the license is uninstalled. |
| LICENSE_STATE_INSTALLATION_IN_PROGRESS | 3 | LICENSE_STATE_INSTALLATION_IN_PROGRESS indicates the license installation is in progress. |
| LICENSE_STATE_UNINSTALLATION_IN_PROGRESS | 4 | LICENSE_STATE_UNINSTALLATION_IN_PROGRESS indicates the license uninstallation is in progress. |
| LICENSE_STATE_INSTALLATION_FAILED | 5 | LICENSE_STATE_INSTALLATION_FAILED indicates the license installation failed. |
| LICENSE_STATE_UNINSTALLATION_FAILED | 6 | LICENSE_STATE_UNINSTALLATION_FAILED indicates the license uninstallation failed. |
PlanName
PlanName is the name of the plan for which the license was purchased.
| Name | Number | Description |
|---|---|---|
| PLAN_NAME_UNSPECIFIED | 0 | PLAN_NAME_UNSPECIFIED refers to unspecified plan name. |
| PLAN_NAME_SUBSCRIPTION | 1 | PLAN_NAME_SUBSCRIPTION refers to the subscription licenses. |
| PLAN_NAME_PERPETUAL | 2 | PLAN_NAME_PERPETUAL refers to the licenses valid for lifetime of the device. |
PreferredBundleReason
PreferredBundleReason indicates the reason a license bundle is preferred.
| Name | Number | Description |
|---|---|---|
| PREFERRED_BUNDLE_REASON_UNSPECIFIED | 0 | PREFERRED_BUNDLE_REASON_UNSPECIFIED indicates an unspecified reason. |
| PREFERRED_BUNDLE_REASON_SALES_ORDER_MATCH | 1 | PREFERRED_BUNDLE_REASON_SALES_ORDER_MATCH indicates a match with the device's sales order. |
| PREFERRED_BUNDLE_REASON_PERPETUAL_PLAN | 2 | PREFERRED_BUNDLE_REASON_PERPETUAL_PLAN indicates that the license is preferred over other licenses as it is a perpetual license |
| PREFERRED_BUNDLE_REASON_PERPETUAL_AND_SALES_ORDER_AGE | 3 | PREFERRED_BUNDLE_REASON_PERPETUAL_AND_SALES_ORDER_AGE indicates a perpetual license with the oldest sales order. |
arista/license.v1/services.gen.proto
ApplicableDevicesBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ApplicableDevices[...] | 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. |
| filter | Filter | For each ApplicableDevices in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ApplicableDevices is streamed to the user. |
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each ApplicableDevices at end. * Each ApplicableDevices response is fully-specified (all fields set). * start: Returns the state of each ApplicableDevices at start, followed by updates until now. * Each ApplicableDevices response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ApplicableDevices at start, followed by updates until end. * Each ApplicableDevices response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
ApplicableDevicesBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | ApplicableDevicesStreamResponse[...] | 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). |
ApplicableDevicesRequest
| Field Name | Type | Description |
|---|---|---|
| key | ApplicableDevicesKey | Key uniquely identifies a ApplicableDevices instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
ApplicableDevicesResponse
| Field Name | Type | Description |
|---|---|---|
| value | ApplicableDevices | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the ApplicableDevices instance in this response. |
ApplicableDevicesSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ApplicableDevicesKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
ApplicableDevicesSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | ApplicableDevices | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the ApplicableDevices instance in this response. |
ApplicableDevicesStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ApplicableDevices[...] | 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. |
| filter | Filter | For each ApplicableDevices in the list, all populated fields are considered ANDed together as a filtering operation. Similarly, the list itself is ORed such that any individual filter that matches a given ApplicableDevices is streamed to the user. |
| time | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each ApplicableDevices at end. * Each ApplicableDevices response is fully-specified (all fields set). * start: Returns the state of each ApplicableDevices at start, followed by updates until now. * Each ApplicableDevices response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ApplicableDevices at start, followed by updates until end. * Each ApplicableDevices response at start is fully-specified, but updates until end may be partial. |
ApplicableDevicesStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | ApplicableDevices | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this ApplicableDevices's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the ApplicableDevices 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. |
ApplicableLicenseBundlesBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ApplicableLicenseBundles[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each ApplicableLicenseBundles at end. * Each ApplicableLicenseBundles response is fully-specified (all fields set). * start: Returns the state of each ApplicableLicenseBundles at start, followed by updates until now. * Each ApplicableLicenseBundles response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ApplicableLicenseBundles at start, followed by updates until end. * Each ApplicableLicenseBundles response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
ApplicableLicenseBundlesBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | ApplicableLicenseBundlesStreamResponse[...] | 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). |
ApplicableLicenseBundlesRequest
| Field Name | Type | Description |
|---|---|---|
| key | ApplicableLicenseBundlesKey | Key uniquely identifies a ApplicableLicenseBundles instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
ApplicableLicenseBundlesResponse
| Field Name | Type | Description |
|---|---|---|
| value | ApplicableLicenseBundles | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the ApplicableLicenseBundles instance in this response. |
ApplicableLicenseBundlesSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | ApplicableLicenseBundlesKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
ApplicableLicenseBundlesSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | ApplicableLicenseBundles | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the ApplicableLicenseBundles instance in this response. |
ApplicableLicenseBundlesStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | ApplicableLicenseBundles[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each ApplicableLicenseBundles at end. * Each ApplicableLicenseBundles response is fully-specified (all fields set). * start: Returns the state of each ApplicableLicenseBundles at start, followed by updates until now. * Each ApplicableLicenseBundles response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each ApplicableLicenseBundles at start, followed by updates until end. * Each ApplicableLicenseBundles response at start is fully-specified, but updates until end may be partial. |
ApplicableLicenseBundlesStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | ApplicableLicenseBundles | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this ApplicableLicenseBundles's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the ApplicableLicenseBundles 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. |
LicenseAssignmentBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseAssignment[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseAssignment at end. * Each LicenseAssignment response is fully-specified (all fields set). * start: Returns the state of each LicenseAssignment at start, followed by updates until now. * Each LicenseAssignment response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseAssignment at start, followed by updates until end. * Each LicenseAssignment response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
LicenseAssignmentBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | LicenseAssignmentStreamResponse[...] | 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). |
LicenseAssignmentConfigBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseAssignmentConfig[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseAssignmentConfig at end. * Each LicenseAssignmentConfig response is fully-specified (all fields set). * start: Returns the state of each LicenseAssignmentConfig at start, followed by updates until now. * Each LicenseAssignmentConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseAssignmentConfig at start, followed by updates until end. * Each LicenseAssignmentConfig response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
LicenseAssignmentConfigBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | LicenseAssignmentConfigStreamResponse[...] | 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). |
LicenseAssignmentConfigDeleteAllRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseAssignmentConfig[...] | 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. |
LicenseAssignmentConfigDeleteAllResponse
| Field Name | Type | Description |
|---|---|---|
| type | fmp.DeleteError | This describes the class of delete error. A DeleteAllResponse is only sent when there is an error. |
| error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
| key | LicenseAssignmentKey | This is the key of the LicenseAssignmentConfig instance that failed to be deleted. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
LicenseAssignmentConfigDeleteRequest
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | Key indicates which LicenseAssignmentConfig instance to remove. This field must always be set. |
LicenseAssignmentConfigDeleteResponse
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | Key echoes back the key of the deleted LicenseAssignmentConfig instance. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==DeletedAt will not include this instance. |
LicenseAssignmentConfigDeleteSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | LicenseAssignmentKey[...] | key contains a list of LicenseAssignmentConfig keys to delete |
LicenseAssignmentConfigDeleteSomeResponse
LicenseAssignmentConfigDeleteSomeResponse is only sent when there is an error.
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | |
| error | string |
LicenseAssignmentConfigRequest
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | Key uniquely identifies a LicenseAssignmentConfig instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseAssignmentConfigResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignmentConfig | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseAssignmentConfig instance in this response. |
LicenseAssignmentConfigSetRequest
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignmentConfig | LicenseAssignmentConfig carries the value to set into the datastore. See the documentation on the LicenseAssignmentConfig struct for which fields are required. |
LicenseAssignmentConfigSetResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignmentConfig | Value carries all the values given in the LicenseAssignmentConfigSetRequest as well as any server-generated values. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance. |
LicenseAssignmentConfigSetSomeRequest
| Field Name | Type | Description |
|---|---|---|
| values | LicenseAssignmentConfig[...] | value contains a list of LicenseAssignmentConfig 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. |
LicenseAssignmentConfigSetSomeResponse
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | |
| error | string |
LicenseAssignmentConfigSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | LicenseAssignmentKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseAssignmentConfigSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignmentConfig | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseAssignmentConfig instance in this response. |
LicenseAssignmentConfigStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseAssignmentConfig[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseAssignmentConfig at end. * Each LicenseAssignmentConfig response is fully-specified (all fields set). * start: Returns the state of each LicenseAssignmentConfig at start, followed by updates until now. * Each LicenseAssignmentConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseAssignmentConfig at start, followed by updates until end. * Each LicenseAssignmentConfig response at start is fully-specified, but updates until end may be partial. |
LicenseAssignmentConfigStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignmentConfig | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this LicenseAssignmentConfig's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the LicenseAssignmentConfig 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. |
LicenseAssignmentRequest
| Field Name | Type | Description |
|---|---|---|
| key | LicenseAssignmentKey | Key uniquely identifies a LicenseAssignment instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseAssignmentResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignment | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseAssignment instance in this response. |
LicenseAssignmentSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | LicenseAssignmentKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseAssignmentSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignment | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseAssignment instance in this response. |
LicenseAssignmentStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseAssignment[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseAssignment at end. * Each LicenseAssignment response is fully-specified (all fields set). * start: Returns the state of each LicenseAssignment at start, followed by updates until now. * Each LicenseAssignment response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseAssignment at start, followed by updates until end. * Each LicenseAssignment response at start is fully-specified, but updates until end may be partial. |
LicenseAssignmentStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseAssignment | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this LicenseAssignment's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the LicenseAssignment 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. |
LicenseFileBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseFile[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseFile at end. * Each LicenseFile response is fully-specified (all fields set). * start: Returns the state of each LicenseFile at start, followed by updates until now. * Each LicenseFile response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseFile at start, followed by updates until end. * Each LicenseFile response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
LicenseFileBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | LicenseFileStreamResponse[...] | 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). |
LicenseFileConfigBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseFileConfig[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseFileConfig at end. * Each LicenseFileConfig response is fully-specified (all fields set). * start: Returns the state of each LicenseFileConfig at start, followed by updates until now. * Each LicenseFileConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseFileConfig at start, followed by updates until end. * Each LicenseFileConfig response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
LicenseFileConfigBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | LicenseFileConfigStreamResponse[...] | 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). |
LicenseFileConfigDeleteAllRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseFileConfig[...] | 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. |
LicenseFileConfigDeleteAllResponse
| Field Name | Type | Description |
|---|---|---|
| type | fmp.DeleteError | This describes the class of delete error. A DeleteAllResponse is only sent when there is an error. |
| error | google.protobuf.StringValue | This indicates the error message from the delete failure. |
| key | LicenseFileKey | This is the key of the LicenseFileConfig instance that failed to be deleted. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp when the key was being deleted. |
LicenseFileConfigDeleteRequest
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | Key indicates which LicenseFileConfig instance to remove. This field must always be set. |
LicenseFileConfigDeleteResponse
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | Key echoes back the key of the deleted LicenseFileConfig instance. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the deletion. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==DeletedAt will not include this instance. |
LicenseFileConfigDeleteSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | LicenseFileKey[...] | key contains a list of LicenseFileConfig keys to delete |
LicenseFileConfigDeleteSomeResponse
LicenseFileConfigDeleteSomeResponse is only sent when there is an error.
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | |
| error | string |
LicenseFileConfigRequest
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | Key uniquely identifies a LicenseFileConfig instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseFileConfigResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFileConfig | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseFileConfig instance in this response. |
LicenseFileConfigSetRequest
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFileConfig | LicenseFileConfig carries the value to set into the datastore. See the documentation on the LicenseFileConfig struct for which fields are required. |
LicenseFileConfigSetResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFileConfig | Value carries all the values given in the LicenseFileConfigSetRequest as well as any server-generated values. |
| time | google.protobuf.Timestamp | Time indicates the (UTC) timestamp at which the system recognizes the creation. The only guarantees made about this timestamp are: - it is after the time the request was received - a time-ranged query with StartTime==CreatedAt will include this instance. |
LicenseFileConfigSetSomeRequest
| Field Name | Type | Description |
|---|---|---|
| values | LicenseFileConfig[...] | value contains a list of LicenseFileConfig 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. |
LicenseFileConfigSetSomeResponse
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | |
| error | string |
LicenseFileConfigSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | LicenseFileKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseFileConfigSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFileConfig | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseFileConfig instance in this response. |
LicenseFileConfigStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseFileConfig[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseFileConfig at end. * Each LicenseFileConfig response is fully-specified (all fields set). * start: Returns the state of each LicenseFileConfig at start, followed by updates until now. * Each LicenseFileConfig response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseFileConfig at start, followed by updates until end. * Each LicenseFileConfig response at start is fully-specified, but updates until end may be partial. |
LicenseFileConfigStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFileConfig | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this LicenseFileConfig's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the LicenseFileConfig 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. |
LicenseFileRequest
| Field Name | Type | Description |
|---|---|---|
| key | LicenseFileKey | Key uniquely identifies a LicenseFile instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseFileResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFile | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseFile instance in this response. |
LicenseFileSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | LicenseFileKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
LicenseFileSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFile | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the LicenseFile instance in this response. |
LicenseFileStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | LicenseFile[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each LicenseFile at end. * Each LicenseFile response is fully-specified (all fields set). * start: Returns the state of each LicenseFile at start, followed by updates until now. * Each LicenseFile response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each LicenseFile at start, followed by updates until end. * Each LicenseFile response at start is fully-specified, but updates until end may be partial. |
LicenseFileStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | LicenseFile | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this LicenseFile's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the LicenseFile value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
MetaResponse
| Field Name | Type | Description |
|---|---|---|
| time | google.protobuf.Timestamp | Time holds the timestamp of the last item included in the metadata calculation. |
| type | arista.subscriptions.Operation | Operation indicates how the value in this response should be considered. Under non-subscribe requests, this value should always be INITIAL. In a subscription, once all initial data is streamed and the client begins to receive modification updates, you should not see INITIAL again. |
| count | google.protobuf.UInt32Value | Count is the number of items present under the conditions of the request. |
PurchasedLicenseBatchedStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | PurchasedLicense[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each PurchasedLicense at end. * Each PurchasedLicense response is fully-specified (all fields set). * start: Returns the state of each PurchasedLicense at start, followed by updates until now. * Each PurchasedLicense response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each PurchasedLicense at start, followed by updates until end. * Each PurchasedLicense response at start is fully-specified, but updates until end may be partial. |
| max_messages | google.protobuf.UInt32Value | 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. |
PurchasedLicenseBatchedStreamResponse
| Field Name | Type | Description |
|---|---|---|
| responses | PurchasedLicenseStreamResponse[...] | 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). |
PurchasedLicenseRequest
| Field Name | Type | Description |
|---|---|---|
| key | PurchasedLicenseKey | Key uniquely identifies a PurchasedLicense instance to retrieve. This value must be populated. |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
PurchasedLicenseResponse
| Field Name | Type | Description |
|---|---|---|
| value | PurchasedLicense | 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. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the PurchasedLicense instance in this response. |
PurchasedLicenseSomeRequest
| Field Name | Type | Description |
|---|---|---|
| keys | PurchasedLicenseKey[...] | |
| time | google.protobuf.Timestamp | Time indicates the time for which you are interested in the data. If no time is given, the server will use the time at which it makes the request. |
PurchasedLicenseSomeResponse
| Field Name | Type | Description |
|---|---|---|
| value | PurchasedLicense | 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. |
| error | google.protobuf.StringValue | Error is an optional field. It should be filled when there is an error in the GetSome process. |
| time | google.protobuf.Timestamp | Time carries the (UTC) timestamp of the last-modification of the PurchasedLicense instance in this response. |
PurchasedLicenseStreamRequest
| Field Name | Type | Description |
|---|---|---|
| partial_eq_filter | PurchasedLicense[...] | 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 | arista.time.TimeBounds | TimeRange allows limiting response data to within a specified time window. If this field is populated, at least one of the two time fields are required. For GetAll, the fields start and end can be used as follows: * end: Returns the state of each PurchasedLicense at end. * Each PurchasedLicense response is fully-specified (all fields set). * start: Returns the state of each PurchasedLicense at start, followed by updates until now. * Each PurchasedLicense response at start is fully-specified, but updates may be partial. * start and end: Returns the state of each PurchasedLicense at start, followed by updates until end. * Each PurchasedLicense response at start is fully-specified, but updates until end may be partial. |
PurchasedLicenseStreamResponse
| Field Name | Type | Description |
|---|---|---|
| value | PurchasedLicense | 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. |
| time | google.protobuf.Timestamp | Time holds the timestamp of this PurchasedLicense's last modification. |
| type | arista.subscriptions.Operation | Operation indicates how the PurchasedLicense 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. |
ApplicableDevicesService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ApplicableDevicesRequest | ApplicableDevicesResponse | |
| GetSome | ApplicableDevicesSomeRequest | ApplicableDevicesSomeResponse stream | |
| GetAll | ApplicableDevicesStreamRequest | ApplicableDevicesStreamResponse stream | |
| Subscribe | ApplicableDevicesStreamRequest | ApplicableDevicesStreamResponse stream | |
| GetMeta | ApplicableDevicesStreamRequest | MetaResponse | |
| SubscribeMeta | ApplicableDevicesStreamRequest | MetaResponse stream | |
| GetAllBatched | ApplicableDevicesBatchedStreamRequest | ApplicableDevicesBatchedStreamResponse stream | |
| SubscribeBatched | ApplicableDevicesBatchedStreamRequest | ApplicableDevicesBatchedStreamResponse stream |
ApplicableLicenseBundlesService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | ApplicableLicenseBundlesRequest | ApplicableLicenseBundlesResponse | |
| GetSome | ApplicableLicenseBundlesSomeRequest | ApplicableLicenseBundlesSomeResponse stream | |
| GetAll | ApplicableLicenseBundlesStreamRequest | ApplicableLicenseBundlesStreamResponse stream | |
| Subscribe | ApplicableLicenseBundlesStreamRequest | ApplicableLicenseBundlesStreamResponse stream | |
| GetMeta | ApplicableLicenseBundlesStreamRequest | MetaResponse | |
| SubscribeMeta | ApplicableLicenseBundlesStreamRequest | MetaResponse stream | |
| GetAllBatched | ApplicableLicenseBundlesBatchedStreamRequest | ApplicableLicenseBundlesBatchedStreamResponse stream | |
| SubscribeBatched | ApplicableLicenseBundlesBatchedStreamRequest | ApplicableLicenseBundlesBatchedStreamResponse stream |
LicenseAssignmentConfigService
LicenseAssignmentService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | LicenseAssignmentRequest | LicenseAssignmentResponse | |
| GetSome | LicenseAssignmentSomeRequest | LicenseAssignmentSomeResponse stream | |
| GetAll | LicenseAssignmentStreamRequest | LicenseAssignmentStreamResponse stream | |
| Subscribe | LicenseAssignmentStreamRequest | LicenseAssignmentStreamResponse stream | |
| GetMeta | LicenseAssignmentStreamRequest | MetaResponse | |
| SubscribeMeta | LicenseAssignmentStreamRequest | MetaResponse stream | |
| GetAllBatched | LicenseAssignmentBatchedStreamRequest | LicenseAssignmentBatchedStreamResponse stream | |
| SubscribeBatched | LicenseAssignmentBatchedStreamRequest | LicenseAssignmentBatchedStreamResponse stream |
LicenseFileConfigService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | LicenseFileConfigRequest | LicenseFileConfigResponse | |
| GetSome | LicenseFileConfigSomeRequest | LicenseFileConfigSomeResponse stream | |
| GetAll | LicenseFileConfigStreamRequest | LicenseFileConfigStreamResponse stream | |
| Subscribe | LicenseFileConfigStreamRequest | LicenseFileConfigStreamResponse stream | |
| GetMeta | LicenseFileConfigStreamRequest | MetaResponse | |
| SubscribeMeta | LicenseFileConfigStreamRequest | MetaResponse stream | |
| Set | LicenseFileConfigSetRequest | LicenseFileConfigSetResponse | |
| SetSome | LicenseFileConfigSetSomeRequest | LicenseFileConfigSetSomeResponse stream | |
| Delete | LicenseFileConfigDeleteRequest | LicenseFileConfigDeleteResponse | |
| DeleteSome | LicenseFileConfigDeleteSomeRequest | LicenseFileConfigDeleteSomeResponse stream | |
| DeleteAll | LicenseFileConfigDeleteAllRequest | LicenseFileConfigDeleteAllResponse stream | |
| GetAllBatched | LicenseFileConfigBatchedStreamRequest | LicenseFileConfigBatchedStreamResponse stream | |
| SubscribeBatched | LicenseFileConfigBatchedStreamRequest | LicenseFileConfigBatchedStreamResponse stream |
LicenseFileService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | LicenseFileRequest | LicenseFileResponse | |
| GetSome | LicenseFileSomeRequest | LicenseFileSomeResponse stream | |
| GetAll | LicenseFileStreamRequest | LicenseFileStreamResponse stream | |
| Subscribe | LicenseFileStreamRequest | LicenseFileStreamResponse stream | |
| GetMeta | LicenseFileStreamRequest | MetaResponse | |
| SubscribeMeta | LicenseFileStreamRequest | MetaResponse stream | |
| GetAllBatched | LicenseFileBatchedStreamRequest | LicenseFileBatchedStreamResponse stream | |
| SubscribeBatched | LicenseFileBatchedStreamRequest | LicenseFileBatchedStreamResponse stream |
PurchasedLicenseService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOne | PurchasedLicenseRequest | PurchasedLicenseResponse | |
| GetSome | PurchasedLicenseSomeRequest | PurchasedLicenseSomeResponse stream | |
| GetAll | PurchasedLicenseStreamRequest | PurchasedLicenseStreamResponse stream | |
| Subscribe | PurchasedLicenseStreamRequest | PurchasedLicenseStreamResponse stream | |
| GetMeta | PurchasedLicenseStreamRequest | MetaResponse | |
| SubscribeMeta | PurchasedLicenseStreamRequest | MetaResponse stream | |
| GetAllBatched | PurchasedLicenseBatchedStreamRequest | PurchasedLicenseBatchedStreamResponse stream | |
| SubscribeBatched | PurchasedLicenseBatchedStreamRequest | PurchasedLicenseBatchedStreamResponse stream |