Canary. |
| Class | Description | |
|---|---|---|
| AdHocEvent | * The details for an AdHoc event returned when searching the events. | |
| AdHocEventTypes | Container for nested types declared in the AdHocEvent message type. | |
| AdHocEventTypesAdHocEventProperty | The property of an AdHoc event. | |
| AggregateConfiguration | * The aggregate configuration detailing how to handle value types and extrapolation. | |
| AggregateDefinition | * The definitions of each aggregate that is supported. | |
| AggregateTagData | * The aggregate data for a specific tag. | |
| AggregateTagRequest | * A request used by GetAggregateDataRequest to specify the details of an aggregate for a tag. | |
| Annotation | * The annotation for the raw data. | |
| AnnotationEntry | * The entry for an annotation which is the data of the annotation. | |
| AnnotationTag | * The annotation for a tag. | |
| AxiomInternalRequest | * A request from Axiom to connect to views. | |
| AxiomInternalResponse | * The response from Axiom | |
| BrowseAutoCompleteRequest | * A request to browse a node to find all items that match the clue passed in. | |
| BrowseAutoCompleteResponse | * The response of the autocomplete browse containing all potential matches. | |
| BrowseInfo | * The information of each child node returned by the Browse request. | |
| BrowseNode | * The Node that was browsed to containing information on the parent and child nodes. | |
| BrowsePathRequest | * A request to browse a specific path in the views browse tree. | |
| BrowsePathResponse | * The response of browsing a specific views path. | |
| BrowseRequest | * A request to browse using the node id to get the specified node | |
| BrowseResponse | * The response from browse request containing the node belong to the ID. | |
| BrowseTagsRequest | * A request to browse the tags for a certain node. | |
| BrowseTagsResponse | * The response of browsing the tags. | |
| CanaryViewsApiService | / Service for handling the API calls made to the Views service. | |
| CanaryViewsApiServiceCanaryViewsApiServiceBase | Base class for server-side implementations of CanaryViewsApiService | |
| CanaryViewsApiServiceCanaryViewsApiServiceClient | Client for CanaryViewsApiService | |
| CanaryViewsApiServiceReflection | Holder for reflection information generated from canary_views_api_service.proto | |
| FindEventsRequest | * A request to find events meeting a certain criteria. | |
| FindEventsResponse | * The response of finding the events. | |
| FindEventsResponseTypes | Container for nested types declared in the FindEventsResponse message type. | |
| GetAggregateDataRequest | * A request to get the aggregate data for the selected tags. | |
| GetAggregateDataResponse | * The response of getting the aggregate data. | |
| GetAggregateDataResponseTypes | Container for nested types declared in the GetAggregateDataResponse message type. | |
| GetAggregateListResponse | * The response from getting a list of the Aggregates. | |
| GetAnnotationsRequest | * A request to get the annotations for the selected tags. | |
| GetAnnotationsResponse | * The response from getting the annotations. | |
| GetAnnotationsResponseTypes | Container for nested types declared in the GetAnnotationsResponse message type. | |
| GetClientConnectionIdRequest | * A request that creates and retrieves the Client ID for the specified user and application. | |
| GetClientConnectionIdResponse | * The response containing the client connection ID and status. | |
| GetDatasetInfoRequest | * A request to get the properties of a specific dataset. | |
| GetDatasetInfoResponse | * The response of getting the Dataset info. | |
| GetDatasetInfoResponseTypes | Container for nested types declared in the GetDatasetInfoResponse message type. | |
| GetDataSetListRequest | * A request to get the datasets associated with a view. | |
| GetDataSetListResponse | * The response of getting the datasets. | |
| GetDataSetListResponseTypes | Container for nested types declared in the GetDataSetListResponse message type. | |
| GetEventCalculationNamesRequest | * An empty request to get the event calculation names. | |
| GetEventCalculationNamesResponse | * The response from getting the event calculation names. | |
| GetEventCalculationNamesResponseTypes | Container for nested types declared in the GetEventCalculationNamesResponse message type. | |
| GetEventPropertyNamesRequest | * An empty request to get the names of the event properties. | |
| GetEventPropertyNamesResponse | * The response from getting the names of the event properties. | |
| GetEventPropertyNamesResponseTypes | Container for nested types declared in the GetEventPropertyNamesResponse message type. | |
| GetHostNameRequest | * A request to get the host name. | |
| GetHostNameResponse | * The response of getting the host name. | |
| GetIdentityEndpointsRequest | * An empty request to get the Identity service endpoints for connection to the Identity service. | |
| GetIdentityEndpointsResponse | * The response from getting the Identity service endpoints for Identity service connections. | |
| GetModelInstancesRequest | * A request to get the model instances. | |
| GetModelInstancesResponse | * The response of getting the model. | |
| GetModelInstancesResponseTypes | Container for nested types declared in the GetModelInstancesResponse message type. | |
| GetModelTypesRequest | * A request to get the types of models. | |
| GetModelTypesResponse | * The response of getting the types of models. | |
| GetModelTypesResponseTypes | Container for nested types declared in the GetModelTypesResponse message type. | |
| GetModelTypeTagsRequest | * A request to get the tags in a model. | |
| GetModelTypeTagsResponse | * The response for getting the tags in a model. | |
| GetModelTypeTagsResponseTypes | Container for nested types declared in the GetModelTypeTagsResponse message type. | |
| GetModelViewsResponse | * The response of getting the model views. | |
| GetRawDataRequest | * A request to get the raw data of the selected tags for the selected time frame. | |
| GetRawDataResponse | * The response of getting the raw data. | |
| GetRawDataResponseTypes | Container for nested types declared in the GetRawDataResponse message type. | |
| GetReadableQualityRequest | * A request to get the readable or string version of the quality. | |
| GetReadableQualityResponse | * The response from getting the readable version of a quality. | |
| GetTagCurrentValueRequest | * A request to get the current vale of the selected tags. | |
| GetTagCurrentValueRequestTypes | Container for nested types declared in the GetTagCurrentValueRequest message type. | |
| GetTagCurrentValueResponse | * The response from getting the current value of tags. | |
| GetTagCurrentValueResponseTypes | Container for nested types declared in the GetTagCurrentValueResponse message type. | |
| GetTagDataContextRequest | * A request to get the context of each tag. | |
| GetTagDataContextResponse | * The response from getting the tag data contexts. | |
| GetTagDataContextResponseTypes | Container for nested types declared in the GetTagDataContextResponse message type. | |
| GetTagInfoRequest | * A request to get the information for the specified tags. | |
| GetTagInfoResponse | * The response from getting the tag information. | |
| GetTagInfoResponseTypes | Container for nested types declared in the GetTagInfoResponse message type. | |
| GetTagListRequest | * A request to get the list of tags in the requested dataset. | |
| GetTagListResponse | * The response from getting tag list. | |
| GetTagListResponseTypes | Container for nested types declared in the GetTagListResponse message type. | |
| GetTagStatisticsRequest | * A request to get the statistics for a tag. | |
| GetTagStatisticsResponse | * The response of getting the statistics for a specific tag. | |
| GetTagStatisticsResponseTypes | Container for nested types declared in the GetTagStatisticsResponse message type. | |
| GetViewInfoRequest | * An empty request to get the information for all views. | |
| GetViewInfoResponse | * The response containing the information for all views. | |
| GetViewInfoResponseTypes | Container for nested types declared in the GetViewInfoResponse message type. | |
| GetViewInfoSingleRequest | * A request to get the information for a specific view. | |
| GetViewInfoSingleResponse | * The response of getting the view information for a specific view. | |
| GetViewInfoSingleResponseTypes | Container for nested types declared in the GetViewInfoSingleResponse message type. | |
| GetViewsRequest | * A request to get all views. | |
| GetViewsResponse | * The response containing all the views and the status of the call. | |
| GetWebServiceInterfaceVersionResponse | * The response from getting the current version of the interface. | |
| GetWebServiceVersionResponse | * The response from getting the current version of the service. | |
| KeepaliveClientConnectionIdRequest | * A request to keep the select client connection alive and working. | |
| KeepaliveClientConnectionIdResponse | * The response from attempting to keep alive the specified connection. | |
| ParseIntervalRequest | * A request to parse the interval from a string to a google.protobuf.Duration. | |
| ParseIntervalResponse | * The response from parsing a string interval to a google.protobuf.Duration. | |
| ParseIntervalResponseTypes | Container for nested types declared in the ParseIntervalResponse message type. | |
| ParseTimestampRequest | * A request to parse the timestamp from a string to a google.protobuf.Timestamp. | |
| ParseTimestampResponse | * The response from parsing a string timestamp to a google.protobuf.Timestamp. | |
| ParseTimestampResponseTypes | Container for nested types declared in the ParseTimestampResponse message type. | |
| RawTagData | * The raw tag data. | |
| RawTagRequest | * A request used by GetRawDataRequest in order to get the right data points. | |
| ReleaseClientConnectionIdRequest | * A request to release the selected client connection ID to close a connection. | |
| ReleaseClientConnectionIdResponse | * The response from releasing the client connection ID. | |
| SearchForEventsRequest | * A request to search for events. | |
| SearchForEventsResponse | * The response of the event search. | |
| SearchForEventsResponseTypes | Container for nested types declared in the SearchForEventsResponse message type. | |
| SearchTags | * The tags that were found to match the search criteria. | |
| SearchTagsTypes | Container for nested types declared in the SearchTags message type. | |
| SearchTagsTypesSearchTagProperty | The property and the property value. | |
| SearchTagsRequest | * A request to search tags based off inputted criteria in a sql like search. | |
| SearchTagsResponse | * The response from searching for tags. | |
| SetVirtualTimeExtensionFlagRequest | * A request to set whether or not to use time extension generation for data. | |
| SetVirtualTimeExtensionFlagResponse | * The response from setting the virtual Time Extension Flag. | |
| StoreAnnotationRequest | * A request to store an annotation. | |
| StoreAnnotationRequestItem | * A request used by StoreAnnotationRequest to specify the annotation details. | |
| StoreAnnotationResponse | * The response of trying to store an annotation. | |
| StoreAnnotationResponseTypes | Container for nested types declared in the StoreAnnotationResponse message type. | |
| StoreDataRequest | * The request of the data to store used by StoreHistoryDataRequest. | |
| StoreDataResult | * The result of storing the history data for a tag. | |
| StoreHistoryDataRequest | * A request to store history data. | |
| StoreHistoryDataResponse | * The response from storing history data containing statuses and the result. | |
| StoreHistoryDataResponseTypes | Container for nested types declared in the StoreHistoryDataResponse message type. | |
| SubscribeToLiveDataRequest | * A request used to subscribe to live data in order to get the data when updated. | |
| SubscribeToLiveDataRequestTypes | Container for nested types declared in the SubscribeToLiveDataRequest message type. | |
| SubscribeToLiveDataResponse | * The response of subscribing to the live data. | |
| SubscribeToLiveDataResponseTypes | Container for nested types declared in the SubscribeToLiveDataResponse message type. | |
| SubscriptionBrowsePath | * The path for browsing to find what to subscribe too. | |
| TagCurrentValue | * The current tag value. | |
| TagDataContext | * The tag data context. | |
| TagInfo | * The information for each tag. | |
| TagProp | * The property of the tag and information regarding the property. | |
| TvqsAndAnnotations | * TVQs and their annotations. | |
| ViewInfo | * The information for a view. |
| Enumeration | Description | |
|---|---|---|
| FindEventsResponseTypesStatus | An enum for the statuses of making a calculations request. | |
| GetAggregateDataResponseTypesStatus | An enum for the status of accessing the view and tags in order to get the aggregate data. | |
| GetAnnotationsResponseTypesStatus | The status of trying to access the view in order to get annotations. | |
| GetDatasetInfoResponseTypesStatus | An enum to cover all statuses that could be returned specific to accessing a dataset. | |
| GetDataSetListResponseTypesStatus | An enum to handle the various statuses that can occur when getting the datasets. | |
| GetEventCalculationNamesResponseTypesStatus | An enum for the statuses of making a calculations request. | |
| GetEventPropertyNamesResponseTypesStatus | An enum for the statuses of making a calculations request. | |
| GetModelInstancesResponseTypesStatus | An enum for the status of accessing the views, models and assets. | |
| GetModelTypesResponseTypesStatus | ||
| GetModelTypeTagsResponseTypesStatus | An enum for the status of accessing views, the model plugin, and browsing tags. | |
| GetRawDataResponseTypesStatus | An enum detailing statuses regarding to accessing the view and the tags. | |
| GetTagCurrentValueRequestTypesQuality | An enum for the qualities a a tag can have as part of the TVQ when filtering. | |
| GetTagCurrentValueResponseTypesStatus | An enum containing the status of accessing the view. | |
| GetTagDataContextResponseTypesStatus | An enum containing the status of accessing the view. | |
| GetTagInfoResponseTypesStatus | An enum containing the status of accessing the view. | |
| GetTagListResponseTypesStatus | An enum to handle the various statuses that can occur when getting the tag list. | |
| GetTagStatisticsResponseTypesStatus | An enum for the status of accessing the view. | |
| GetViewInfoResponseTypesStatus | An enum for the status of getting the properties. | |
| GetViewInfoSingleResponseTypesStatus | An enum for the status of accessing the view and the properties. | |
| ParseIntervalResponseTypesStatus | An enum for the status of trying to parse the string. | |
| ParseTimestampResponseTypesStatus | An enum for the status of trying to parse the string. | |
| SearchForEventsResponseTypesStatus | An enum for the status of accessing the events. | |
| StoreAnnotationResponseTypesStatus | An enum of the statuses that could occur when saving an annotation. | |
| StoreHistoryDataResponseTypesStatus | An enum for the status of accessing the view. | |
| SubscribeToLiveDataRequestTypesTagPathNormalizationBehavior | ||
| SubscribeToLiveDataResponseTypesStatus | An enum with the statuses of trying to access the tags. |