Skip to main content
Version: Trunk

license.v1

Version: 1.1.0

Available Services

    ApplicableDevicesService

    ApplicableLicenseBundlesService

    LicenseAssignmentConfigService

    LicenseAssignmentService

    LicenseFileConfigService

    LicenseFileService

    PurchasedLicenseService

Top

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 NameTypeDescription
keyApplicableDevicesKey

key uniquely identifies applicable devices.

device_licenses_dataDeviceData

device_licenses_data is basic device data with licenses it has.

ApplicableDevicesKey

ApplicableDevicesKey uniquely identifies an ApplicableDevice for a feature.

Field NameTypeDescription
featureFeature

feature is the name of license feature.

device_serialgoogle.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 NameTypeDescription
keyApplicableLicenseBundlesKey

key is the key identifying the bundle request.

bundlesRepeatedLicenseBundle

bundles is a list of applicable license bundles.

There should be at most one preferred bundle in the list.

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 NameTypeDescription
featureFeature

feature is the name of license feature.

device_serialgoogle.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 NameTypeDescription
serialgoogle.protobuf.StringValue

serial is the serial number of the device.

hostnamegoogle.protobuf.StringValue

hostname is the hostname of the device.

sales_order_numbergoogle.protobuf.StringValue

sales_order_number is the sales order of the device.

modelgoogle.protobuf.StringValue

model is the model name of the device.

platform_classesfmp.RepeatedString

platform_classes are the supported license platform classes of the device.

licensesRepeatedLicenseInfo

licenses which are already installed on the device.

applicable_license_skusfmp.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 NameTypeDescription
valuesDeviceLicenseStatus.ValuesEntry[...]

values is a map of deviceID to installation status.

DeviceLicenseStatus.ValuesEntry

Field NameTypeDescription
keystring

valueLicenseStatus

Filter

Filter is used to filter devices based on licenses installed on it.

Field NameTypeDescription
has_perpetual_licensegoogle.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 NameTypeDescription
keyLicenseAssignmentKey

key uniquely identifies a license assignment for the device.

license_uuidgoogle.protobuf.StringValue

license_uuid is a unique id associated with a license.

license_file_serialgoogle.protobuf.StringValue

license_file_serial is unique serial number embedded

in the license file.

statusAssignmentStatus

status is device assignment status.

assign_timegoogle.protobuf.Timestamp

assign_time is the time when the license is assigned.

errorgoogle.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 NameTypeDescription
keyLicenseAssignmentKey

key uniquely identifies a license assignment for the device.

assignedgoogle.protobuf.BoolValue

assigned indicates whether the license

should be assigned or unassigned.

LicenseAssignmentKey

LicenseAssignmentKey uniquely identifies a license.

Field NameTypeDescription
license_bundle_uuidgoogle.protobuf.StringValue

license_bundle_uuid is a unique id of the license bundle.

devicegoogle.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 NameTypeDescription
license_bundle_uuidgoogle.protobuf.StringValue

license_bundle_uuid is a unique id of the license bundle.

sales_order_numbergoogle.protobuf.Int64Value

sales_order_number is the sales order number for the purchased license bundle.

skugoogle.protobuf.StringValue

sku represents the name of the sku which is combination

of platform and feature name. Example: LIC-FIX-4-MACSEC

plan_namePlanName

plan_name indicates type of license (perpetual/subscription).

start_timegoogle.protobuf.Timestamp

start_time is the time when the license comes into force.

end_timegoogle.protobuf.Timestamp

end_time is the time when the license expires.

total_license_countgoogle.protobuf.UInt64Value

total_license_count is the total number of licenses purchased in this bundle.

unassigned_license_countgoogle.protobuf.UInt64Value

unassigned_license_count is the number of licenses that are currently unassigned in this bundle.

is_preferredgoogle.protobuf.BoolValue

is_preferred indicates if this bundle is the preferred bundle.

preferred_bundle_reasonPreferredBundleReason

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 NameTypeDescription
keyLicenseFileKey

key uniquely identifies a license file.

versiongoogle.protobuf.StringValue

version is the version number of the license file.

customer_namegoogle.protobuf.StringValue

customer_name is the name of customer

who owns this license file.

device_license_statusDeviceLicenseStatus

device_license_status contains mapping of assigned.

devices to license installation status.

featureFeature

feature is the name of license feature

that this license file refers to.

start_timegoogle.protobuf.Timestamp

start_time is the time when the license comes into force.

end_timegoogle.protobuf.Timestamp

end_time is the time when the license expires.

sourceLicenseSource

source is the means by which the

license file was obtained.

file_namegoogle.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 NameTypeDescription
keyLicenseFileKey

key uniquely identifies a license file.

license_file_jsongoogle.protobuf.StringValue

license_file_json is the JSON string

of the license file.

installedgoogle.protobuf.BoolValue

installed indicates whether the license file

should be installed or uninstalled.

LicenseFileKey

LicenseFileKey uniquely identifies a license file.

Field NameTypeDescription
license_file_serialgoogle.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 NameTypeDescription
start_timegoogle.protobuf.Timestamp

start_time is the time when the license starts its effect.

end_timegoogle.protobuf.Timestamp

end_time is the time when the license will be terminated.

grace_periodgoogle.protobuf.UInt32Value

grace_period is the number of days a license is valid after expiry.

plan_namePlanName

plan_name indicates type of license (perpetual/subscription).

LicenseStatus

LicenseStatus contains license installation state and error.

Field NameTypeDescription
stateLicenseState

state is the installation status

of the license file on the device.

errorgoogle.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 NameTypeDescription
keyPurchasedLicenseKey

key uniquely identifies a license.

assigned_devicegoogle.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_numbergoogle.protobuf.StringValue

so_number is the sales order number for the purchased license.

license_bundle_uuidgoogle.protobuf.StringValue

license_bundle_uuid is a unique id of the license bundle.

skugoogle.protobuf.StringValue

sku represents the name of the sku which is combination

of platform and feature name. Example: LIC-FIX-4-MACSEC

featureFeature

feature is the name of the feature for which the

license was purchased.

start_timegoogle.protobuf.Timestamp

start_time is the time when the license comes into force.

end_timegoogle.protobuf.Timestamp

end_time is the time when the license expires.

plan_namePlanName

plan_name indicates type of license (perpetual/ subscription).

original_subscription_record_numbergoogle.protobuf.Int64Value

original_subscription_record_number is the parent subscription record number.

original_sales_order_numbergoogle.protobuf.Int64Value

original_sales_order_number is the parent sales order number.

renewal_statusgoogle.protobuf.StringValue

renewal_status is the renewal status of license.

renewal_status_dategoogle.protobuf.Timestamp

renewal_status_date is the renewal date of license.

end_customer_parent_account_idgoogle.protobuf.Int64Value

end_customer_parent_account_id is the parent company ID.

end_customer_parent_account_namegoogle.protobuf.StringValue

end_customer_parent_account_name is the parent company name.

platform_classgoogle.protobuf.StringValue

platform_class is the platform class of the license sku.

PurchasedLicenseKey

PurchasedLicenseKey uniquely identifies a license.

Field NameTypeDescription
license_uuidgoogle.protobuf.StringValue

license_uuid is a unique id associated with a license.

RepeatedLicenseBundle

RepeatedLicenseBundle is a wrapper around LicenseBundle.

Field NameTypeDescription
valuesLicenseBundle[...]

values store the details of license bundles.

RepeatedLicenseInfo

RepeatedLicenseInfo is a wrapper around LicenseInfo.

Field NameTypeDescription
valuesLicenseInfo[...]

values store the details of licenses installed on the devices.

AssignmentStatus

AssignmentStatus enumerates the set of execution statuses of device assignment.

NameNumberDescription
ASSIGNMENT_STATUS_UNSPECIFIED0

ASSIGNMENT_STATUS_UNSPECIFIED refers to unspecified status.

ASSIGNMENT_STATUS_ASSIGNMENT_IN_PROGRESS1

ASSIGNMENT_STATUS_ASSIGNMENT_IN_PROGRESS indicates device assignment is in progress.

ASSIGNMENT_STATUS_ASSIGNMENT_SUCCESS2

ASSIGNMENT_STATUS_ASSIGNMENT_SUCCESS indicates device assignment succeeded.

ASSIGNMENT_STATUS_ASSIGNMENT_FAILURE3

ASSIGNMENT_STATUS_ASSIGNMENT_FAILURE indicates device assignment failed.

ASSIGNMENT_STATUS_UNASSIGNMENT_IN_PROGRESS4

ASSIGNMENT_STATUS_UNASSIGNMENT_IN_PROGRESS indicates device unassignment is in progress.

ASSIGNMENT_STATUS_UNASSIGNMENT_SUCCESS5

ASSIGNMENT_STATUS_UNASSIGNMENT_SUCCESS indicates device unassignment succeeded.

ASSIGNMENT_STATUS_UNASSIGNMENT_FAILURE6

ASSIGNMENT_STATUS_UNASSIGNMENT_FAILURE indicates device unassignment failed.

Feature

Feature is the name of the feature for which the license was purchased.

NameNumberDescription
FEATURE_UNSPECIFIED0

FEATURE_UNSPECIFIED refers to

unspecified license feature.

FEATURE_IPSEC1

FEATURE_IPSEC refers to the feature IPSEC.

FEATURE_MACSEC2

FEATURE_MACSEC refers to the feature MACSEC.

FEATURE_ENCR3

FEATURE_ENCR refers to the encryption.

FEATURE_CLOUDEOS4

FEATURE_CLOUDEOS refers to the feature CLOUDEOS.

FEATURE_CVPATHFINDER5

FEATURE_CVPATHFINDER refers to the feature CVPATHFINDER.

LicenseScope

LicenseScope indicates the number of devices a license supports.

NameNumberDescription
LICENSE_SCOPE_UNSPECIFIED0

LICENSE_SCOPE_UNSPECIFIED indicates an unspecified license scope.

LICENSE_SCOPE_SINGLE_DEVICE1

LICENSE_SCOPE_SINGLE_DEVICE indicates a license file that supports a single device.

LICENSE_SCOPE_MULTIPLE_DEVICE2

LICENSE_SCOPE_MULTIPLE_DEVICE indicates a license file that supports multiple devices.

LicenseSource

LicenseSource is the source from where license file has been obtained.

NameNumberDescription
LICENSE_SOURCE_UNSPECIFIED0

LICENSE_SOURCE_UNSPECIFIED refers to

unspecified license source.

LICENSE_SOURCE_USER_UPLOAD1

LICENSE_SOURCE_USER_UPLOAD refers

to the license source as uploaded

by user through UI.

LICENSE_SOURCE_DISCOVERED2

LICENSE_SOURCE_DISCOVERED refers to

the license source as being discovered

from device where license was manually

installed.

LICENSE_SOURCE_PROCURED3

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.

NameNumberDescription
LICENSE_STATE_UNSPECIFIED0

LICENSE_STATE_UNSPECIFIED indicates an unspecified license state.

LICENSE_STATE_INSTALLED1

LICENSE_STATE_INSTALLED indicates the license is installed.

LICENSE_STATE_UNINSTALLED2

LICENSE_STATE_UNINSTALLED indicates the license is uninstalled.

LICENSE_STATE_INSTALLATION_IN_PROGRESS3

LICENSE_STATE_INSTALLATION_IN_PROGRESS indicates the license installation is in progress.

LICENSE_STATE_UNINSTALLATION_IN_PROGRESS4

LICENSE_STATE_UNINSTALLATION_IN_PROGRESS indicates the license uninstallation is in progress.

LICENSE_STATE_INSTALLATION_FAILED5

LICENSE_STATE_INSTALLATION_FAILED indicates the license installation failed.

LICENSE_STATE_UNINSTALLATION_FAILED6

LICENSE_STATE_UNINSTALLATION_FAILED indicates the license uninstallation failed.

PlanName

PlanName is the name of the plan for which the license was purchased.

NameNumberDescription
PLAN_NAME_UNSPECIFIED0

PLAN_NAME_UNSPECIFIED refers to unspecified plan name.

PLAN_NAME_SUBSCRIPTION1

PLAN_NAME_SUBSCRIPTION refers to the subscription licenses.

PLAN_NAME_PERPETUAL2

PLAN_NAME_PERPETUAL refers to the licenses valid for lifetime of the device.

PreferredBundleReason

PreferredBundleReason indicates the reason a license bundle is preferred.

NameNumberDescription
PREFERRED_BUNDLE_REASON_UNSPECIFIED0

PREFERRED_BUNDLE_REASON_UNSPECIFIED indicates an unspecified reason.

PREFERRED_BUNDLE_REASON_SALES_ORDER_MATCH1

PREFERRED_BUNDLE_REASON_SALES_ORDER_MATCH indicates a match with the device's sales order.

PREFERRED_BUNDLE_REASON_PERPETUAL_PLAN2

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_AGE3

PREFERRED_BUNDLE_REASON_PERPETUAL_AND_SALES_ORDER_AGE indicates a perpetual license

with the oldest sales order.

Top

arista/license.v1/services.gen.proto

ApplicableDevicesBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterApplicableDevices[...]

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.

filterFilter

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesApplicableDevicesStreamResponse[...]

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 NameTypeDescription
keyApplicableDevicesKey

Key uniquely identifies a ApplicableDevices instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueApplicableDevices

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

ApplicableDevices instance in this response.

ApplicableDevicesSomeRequest

Field NameTypeDescription
keysApplicableDevicesKey[...]

timegoogle.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 NameTypeDescription
valueApplicableDevices

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

ApplicableDevices instance in this response.

ApplicableDevicesStreamRequest

Field NameTypeDescription
partial_eq_filterApplicableDevices[...]

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.

filterFilter

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.

timearista.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 NameTypeDescription
valueApplicableDevices

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this ApplicableDevices's last modification.

typearista.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 NameTypeDescription
partial_eq_filterApplicableLicenseBundles[...]

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesApplicableLicenseBundlesStreamResponse[...]

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 NameTypeDescription
keyApplicableLicenseBundlesKey

Key uniquely identifies a ApplicableLicenseBundles instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueApplicableLicenseBundles

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

ApplicableLicenseBundles instance in this response.

ApplicableLicenseBundlesSomeRequest

Field NameTypeDescription
keysApplicableLicenseBundlesKey[...]

timegoogle.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 NameTypeDescription
valueApplicableLicenseBundles

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

ApplicableLicenseBundles instance in this response.

ApplicableLicenseBundlesStreamRequest

Field NameTypeDescription
partial_eq_filterApplicableLicenseBundles[...]

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.

timearista.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 NameTypeDescription
valueApplicableLicenseBundles

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this ApplicableLicenseBundles's last modification.

typearista.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 NameTypeDescription
partial_eq_filterLicenseAssignment[...]

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesLicenseAssignmentStreamResponse[...]

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 NameTypeDescription
partial_eq_filterLicenseAssignmentConfig[...]

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesLicenseAssignmentConfigStreamResponse[...]

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 NameTypeDescription
partial_eq_filterLicenseAssignmentConfig[...]

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 NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyLicenseAssignmentKey

This is the key of the LicenseAssignmentConfig instance that failed to be deleted.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp when the key was being deleted.

LicenseAssignmentConfigDeleteRequest

Field NameTypeDescription
keyLicenseAssignmentKey

Key indicates which LicenseAssignmentConfig instance to remove.

This field must always be set.

LicenseAssignmentConfigDeleteResponse

Field NameTypeDescription
keyLicenseAssignmentKey

Key echoes back the key of the deleted LicenseAssignmentConfig instance.

timegoogle.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 NameTypeDescription
keysLicenseAssignmentKey[...]

key contains a list of LicenseAssignmentConfig keys to delete

LicenseAssignmentConfigDeleteSomeResponse

LicenseAssignmentConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyLicenseAssignmentKey

errorstring

LicenseAssignmentConfigRequest

Field NameTypeDescription
keyLicenseAssignmentKey

Key uniquely identifies a LicenseAssignmentConfig instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueLicenseAssignmentConfig

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseAssignmentConfig instance in this response.

LicenseAssignmentConfigSetRequest

Field NameTypeDescription
valueLicenseAssignmentConfig

LicenseAssignmentConfig carries the value to set into the datastore.

See the documentation on the LicenseAssignmentConfig struct for which fields are required.

LicenseAssignmentConfigSetResponse

Field NameTypeDescription
valueLicenseAssignmentConfig

Value carries all the values given in the LicenseAssignmentConfigSetRequest as well

as any server-generated values.

timegoogle.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 NameTypeDescription
valuesLicenseAssignmentConfig[...]

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 NameTypeDescription
keyLicenseAssignmentKey

errorstring

LicenseAssignmentConfigSomeRequest

Field NameTypeDescription
keysLicenseAssignmentKey[...]

timegoogle.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 NameTypeDescription
valueLicenseAssignmentConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseAssignmentConfig instance in this response.

LicenseAssignmentConfigStreamRequest

Field NameTypeDescription
partial_eq_filterLicenseAssignmentConfig[...]

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.

timearista.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 NameTypeDescription
valueLicenseAssignmentConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this LicenseAssignmentConfig's last modification.

typearista.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 NameTypeDescription
keyLicenseAssignmentKey

Key uniquely identifies a LicenseAssignment instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueLicenseAssignment

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseAssignment instance in this response.

LicenseAssignmentSomeRequest

Field NameTypeDescription
keysLicenseAssignmentKey[...]

timegoogle.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 NameTypeDescription
valueLicenseAssignment

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseAssignment instance in this response.

LicenseAssignmentStreamRequest

Field NameTypeDescription
partial_eq_filterLicenseAssignment[...]

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.

timearista.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 NameTypeDescription
valueLicenseAssignment

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this LicenseAssignment's last modification.

typearista.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 NameTypeDescription
partial_eq_filterLicenseFile[...]

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesLicenseFileStreamResponse[...]

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 NameTypeDescription
partial_eq_filterLicenseFileConfig[...]

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesLicenseFileConfigStreamResponse[...]

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 NameTypeDescription
partial_eq_filterLicenseFileConfig[...]

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 NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyLicenseFileKey

This is the key of the LicenseFileConfig instance that failed to be deleted.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp when the key was being deleted.

LicenseFileConfigDeleteRequest

Field NameTypeDescription
keyLicenseFileKey

Key indicates which LicenseFileConfig instance to remove.

This field must always be set.

LicenseFileConfigDeleteResponse

Field NameTypeDescription
keyLicenseFileKey

Key echoes back the key of the deleted LicenseFileConfig instance.

timegoogle.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 NameTypeDescription
keysLicenseFileKey[...]

key contains a list of LicenseFileConfig keys to delete

LicenseFileConfigDeleteSomeResponse

LicenseFileConfigDeleteSomeResponse is only sent when there is an error.

Field NameTypeDescription
keyLicenseFileKey

errorstring

LicenseFileConfigRequest

Field NameTypeDescription
keyLicenseFileKey

Key uniquely identifies a LicenseFileConfig instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueLicenseFileConfig

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseFileConfig instance in this response.

LicenseFileConfigSetRequest

Field NameTypeDescription
valueLicenseFileConfig

LicenseFileConfig carries the value to set into the datastore.

See the documentation on the LicenseFileConfig struct for which fields are required.

LicenseFileConfigSetResponse

Field NameTypeDescription
valueLicenseFileConfig

Value carries all the values given in the LicenseFileConfigSetRequest as well

as any server-generated values.

timegoogle.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 NameTypeDescription
valuesLicenseFileConfig[...]

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 NameTypeDescription
keyLicenseFileKey

errorstring

LicenseFileConfigSomeRequest

Field NameTypeDescription
keysLicenseFileKey[...]

timegoogle.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 NameTypeDescription
valueLicenseFileConfig

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseFileConfig instance in this response.

LicenseFileConfigStreamRequest

Field NameTypeDescription
partial_eq_filterLicenseFileConfig[...]

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.

timearista.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 NameTypeDescription
valueLicenseFileConfig

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this LicenseFileConfig's last modification.

typearista.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 NameTypeDescription
keyLicenseFileKey

Key uniquely identifies a LicenseFile instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valueLicenseFile

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseFile instance in this response.

LicenseFileSomeRequest

Field NameTypeDescription
keysLicenseFileKey[...]

timegoogle.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 NameTypeDescription
valueLicenseFile

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

LicenseFile instance in this response.

LicenseFileStreamRequest

Field NameTypeDescription
partial_eq_filterLicenseFile[...]

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.

timearista.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 NameTypeDescription
valueLicenseFile

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this LicenseFile's last modification.

typearista.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 NameTypeDescription
timegoogle.protobuf.Timestamp

Time holds the timestamp of the last item included in the metadata calculation.

typearista.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.

countgoogle.protobuf.UInt32Value

Count is the number of items present under the conditions of the request.

PurchasedLicenseBatchedStreamRequest

Field NameTypeDescription
partial_eq_filterPurchasedLicense[...]

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.

timearista.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_messagesgoogle.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 NameTypeDescription
responsesPurchasedLicenseStreamResponse[...]

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 NameTypeDescription
keyPurchasedLicenseKey

Key uniquely identifies a PurchasedLicense instance to retrieve.

This value must be populated.

timegoogle.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 NameTypeDescription
valuePurchasedLicense

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.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

PurchasedLicense instance in this response.

PurchasedLicenseSomeRequest

Field NameTypeDescription
keysPurchasedLicenseKey[...]

timegoogle.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 NameTypeDescription
valuePurchasedLicense

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.

errorgoogle.protobuf.StringValue

Error is an optional field.

It should be filled when there is an error in the GetSome process.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

PurchasedLicense instance in this response.

PurchasedLicenseStreamRequest

Field NameTypeDescription
partial_eq_filterPurchasedLicense[...]

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.

timearista.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 NameTypeDescription
valuePurchasedLicense

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.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this PurchasedLicense's last modification.

typearista.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 NameRequest TypeResponse TypeDescription
GetOneApplicableDevicesRequestApplicableDevicesResponse

GetSomeApplicableDevicesSomeRequestApplicableDevicesSomeResponse stream

GetAllApplicableDevicesStreamRequestApplicableDevicesStreamResponse stream

SubscribeApplicableDevicesStreamRequestApplicableDevicesStreamResponse stream

GetMetaApplicableDevicesStreamRequestMetaResponse

SubscribeMetaApplicableDevicesStreamRequestMetaResponse stream

GetAllBatchedApplicableDevicesBatchedStreamRequestApplicableDevicesBatchedStreamResponse stream

SubscribeBatchedApplicableDevicesBatchedStreamRequestApplicableDevicesBatchedStreamResponse stream

ApplicableLicenseBundlesService

Method NameRequest TypeResponse TypeDescription
GetOneApplicableLicenseBundlesRequestApplicableLicenseBundlesResponse

GetSomeApplicableLicenseBundlesSomeRequestApplicableLicenseBundlesSomeResponse stream

GetAllApplicableLicenseBundlesStreamRequestApplicableLicenseBundlesStreamResponse stream

SubscribeApplicableLicenseBundlesStreamRequestApplicableLicenseBundlesStreamResponse stream

GetMetaApplicableLicenseBundlesStreamRequestMetaResponse

SubscribeMetaApplicableLicenseBundlesStreamRequestMetaResponse stream

GetAllBatchedApplicableLicenseBundlesBatchedStreamRequestApplicableLicenseBundlesBatchedStreamResponse stream

SubscribeBatchedApplicableLicenseBundlesBatchedStreamRequestApplicableLicenseBundlesBatchedStreamResponse stream

LicenseAssignmentConfigService

Method NameRequest TypeResponse TypeDescription
GetOneLicenseAssignmentConfigRequestLicenseAssignmentConfigResponse

GetSomeLicenseAssignmentConfigSomeRequestLicenseAssignmentConfigSomeResponse stream

GetAllLicenseAssignmentConfigStreamRequestLicenseAssignmentConfigStreamResponse stream

SubscribeLicenseAssignmentConfigStreamRequestLicenseAssignmentConfigStreamResponse stream

GetMetaLicenseAssignmentConfigStreamRequestMetaResponse

SubscribeMetaLicenseAssignmentConfigStreamRequestMetaResponse stream

SetLicenseAssignmentConfigSetRequestLicenseAssignmentConfigSetResponse

SetSomeLicenseAssignmentConfigSetSomeRequestLicenseAssignmentConfigSetSomeResponse stream

DeleteLicenseAssignmentConfigDeleteRequestLicenseAssignmentConfigDeleteResponse

DeleteSomeLicenseAssignmentConfigDeleteSomeRequestLicenseAssignmentConfigDeleteSomeResponse stream

DeleteAllLicenseAssignmentConfigDeleteAllRequestLicenseAssignmentConfigDeleteAllResponse stream

GetAllBatchedLicenseAssignmentConfigBatchedStreamRequestLicenseAssignmentConfigBatchedStreamResponse stream

SubscribeBatchedLicenseAssignmentConfigBatchedStreamRequestLicenseAssignmentConfigBatchedStreamResponse stream

LicenseAssignmentService

Method NameRequest TypeResponse TypeDescription
GetOneLicenseAssignmentRequestLicenseAssignmentResponse

GetSomeLicenseAssignmentSomeRequestLicenseAssignmentSomeResponse stream

GetAllLicenseAssignmentStreamRequestLicenseAssignmentStreamResponse stream

SubscribeLicenseAssignmentStreamRequestLicenseAssignmentStreamResponse stream

GetMetaLicenseAssignmentStreamRequestMetaResponse

SubscribeMetaLicenseAssignmentStreamRequestMetaResponse stream

GetAllBatchedLicenseAssignmentBatchedStreamRequestLicenseAssignmentBatchedStreamResponse stream

SubscribeBatchedLicenseAssignmentBatchedStreamRequestLicenseAssignmentBatchedStreamResponse stream

LicenseFileConfigService

Method NameRequest TypeResponse TypeDescription
GetOneLicenseFileConfigRequestLicenseFileConfigResponse

GetSomeLicenseFileConfigSomeRequestLicenseFileConfigSomeResponse stream

GetAllLicenseFileConfigStreamRequestLicenseFileConfigStreamResponse stream

SubscribeLicenseFileConfigStreamRequestLicenseFileConfigStreamResponse stream

GetMetaLicenseFileConfigStreamRequestMetaResponse

SubscribeMetaLicenseFileConfigStreamRequestMetaResponse stream

SetLicenseFileConfigSetRequestLicenseFileConfigSetResponse

SetSomeLicenseFileConfigSetSomeRequestLicenseFileConfigSetSomeResponse stream

DeleteLicenseFileConfigDeleteRequestLicenseFileConfigDeleteResponse

DeleteSomeLicenseFileConfigDeleteSomeRequestLicenseFileConfigDeleteSomeResponse stream

DeleteAllLicenseFileConfigDeleteAllRequestLicenseFileConfigDeleteAllResponse stream

GetAllBatchedLicenseFileConfigBatchedStreamRequestLicenseFileConfigBatchedStreamResponse stream

SubscribeBatchedLicenseFileConfigBatchedStreamRequestLicenseFileConfigBatchedStreamResponse stream

LicenseFileService

Method NameRequest TypeResponse TypeDescription
GetOneLicenseFileRequestLicenseFileResponse

GetSomeLicenseFileSomeRequestLicenseFileSomeResponse stream

GetAllLicenseFileStreamRequestLicenseFileStreamResponse stream

SubscribeLicenseFileStreamRequestLicenseFileStreamResponse stream

GetMetaLicenseFileStreamRequestMetaResponse

SubscribeMetaLicenseFileStreamRequestMetaResponse stream

GetAllBatchedLicenseFileBatchedStreamRequestLicenseFileBatchedStreamResponse stream

SubscribeBatchedLicenseFileBatchedStreamRequestLicenseFileBatchedStreamResponse stream

PurchasedLicenseService

Method NameRequest TypeResponse TypeDescription
GetOnePurchasedLicenseRequestPurchasedLicenseResponse

GetSomePurchasedLicenseSomeRequestPurchasedLicenseSomeResponse stream

GetAllPurchasedLicenseStreamRequestPurchasedLicenseStreamResponse stream

SubscribePurchasedLicenseStreamRequestPurchasedLicenseStreamResponse stream

GetMetaPurchasedLicenseStreamRequestMetaResponse

SubscribeMetaPurchasedLicenseStreamRequestMetaResponse stream

GetAllBatchedPurchasedLicenseBatchedStreamRequestPurchasedLicenseBatchedStreamResponse stream

SubscribeBatchedPurchasedLicenseBatchedStreamRequestPurchasedLicenseBatchedStreamResponse stream