Package Classes (0.1.5)

Version latest

• 0.1.5 (latest)
• 0.1.4

Summary of entries of Classes for google-cloud-visionai.

Classes

AppPlatformAsyncClient

Service describing handlers for resources

AppPlatformClient

Service describing handlers for resources

ListApplicationsAsyncPager

A pager for iterating through list_applications requests.

This class thinly wraps an initial ListApplicationsResponse object, and provides an __aiter__ method to iterate through its applications field.

If there are more pages, the __aiter__ method will make additional ListApplications requests and continue to iterate through the applications field on the corresponding responses.

All the usual ListApplicationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListApplicationsPager

A pager for iterating through list_applications requests.

This class thinly wraps an initial ListApplicationsResponse object, and provides an __iter__ method to iterate through its applications field.

If there are more pages, the __iter__ method will make additional ListApplications requests and continue to iterate through the applications field on the corresponding responses.

All the usual ListApplicationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDraftsAsyncPager

A pager for iterating through list_drafts requests.

This class thinly wraps an initial ListDraftsResponse object, and provides an __aiter__ method to iterate through its drafts field.

If there are more pages, the __aiter__ method will make additional ListDrafts requests and continue to iterate through the drafts field on the corresponding responses.

All the usual ListDraftsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDraftsPager

A pager for iterating through list_drafts requests.

This class thinly wraps an initial ListDraftsResponse object, and provides an __iter__ method to iterate through its drafts field.

If there are more pages, the __iter__ method will make additional ListDrafts requests and continue to iterate through the drafts field on the corresponding responses.

All the usual ListDraftsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInstancesAsyncPager

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __aiter__ method to iterate through its instances field.

If there are more pages, the __aiter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInstancesPager

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __iter__ method to iterate through its instances field.

If there are more pages, the __iter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProcessorsAsyncPager

A pager for iterating through list_processors requests.

This class thinly wraps an initial ListProcessorsResponse object, and provides an __aiter__ method to iterate through its processors field.

If there are more pages, the __aiter__ method will make additional ListProcessors requests and continue to iterate through the processors field on the corresponding responses.

All the usual ListProcessorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProcessorsPager

A pager for iterating through list_processors requests.

This class thinly wraps an initial ListProcessorsResponse object, and provides an __iter__ method to iterate through its processors field.

If there are more pages, the __iter__ method will make additional ListProcessors requests and continue to iterate through the processors field on the corresponding responses.

All the usual ListProcessorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

HealthCheckServiceAsyncClient

HealthCheckService provides an interface for Vertex AI Vision Cluster Health Check.

HealthCheckServiceClient

HealthCheckService provides an interface for Vertex AI Vision Cluster Health Check.

LiveVideoAnalyticsAsyncClient

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

LiveVideoAnalyticsClient

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

ListAnalysesAsyncPager

A pager for iterating through list_analyses requests.

This class thinly wraps an initial ListAnalysesResponse object, and provides an __aiter__ method to iterate through its analyses field.

If there are more pages, the __aiter__ method will make additional ListAnalyses requests and continue to iterate through the analyses field on the corresponding responses.

All the usual ListAnalysesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAnalysesPager

A pager for iterating through list_analyses requests.

This class thinly wraps an initial ListAnalysesResponse object, and provides an __iter__ method to iterate through its analyses field.

If there are more pages, the __iter__ method will make additional ListAnalyses requests and continue to iterate through the analyses field on the corresponding responses.

All the usual ListAnalysesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListOperatorsAsyncPager

A pager for iterating through list_operators requests.

This class thinly wraps an initial ListOperatorsResponse object, and provides an __aiter__ method to iterate through its operators field.

If there are more pages, the __aiter__ method will make additional ListOperators requests and continue to iterate through the operators field on the corresponding responses.

All the usual ListOperatorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListOperatorsPager

A pager for iterating through list_operators requests.

This class thinly wraps an initial ListOperatorsResponse object, and provides an __iter__ method to iterate through its operators field.

If there are more pages, the __iter__ method will make additional ListOperators requests and continue to iterate through the operators field on the corresponding responses.

All the usual ListOperatorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProcessesAsyncPager

A pager for iterating through list_processes requests.

This class thinly wraps an initial ListProcessesResponse object, and provides an __aiter__ method to iterate through its processes field.

If there are more pages, the __aiter__ method will make additional ListProcesses requests and continue to iterate through the processes field on the corresponding responses.

All the usual ListProcessesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProcessesPager

A pager for iterating through list_processes requests.

This class thinly wraps an initial ListProcessesResponse object, and provides an __iter__ method to iterate through its processes field.

If there are more pages, the __iter__ method will make additional ListProcesses requests and continue to iterate through the processes field on the corresponding responses.

All the usual ListProcessesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPublicOperatorsAsyncPager

A pager for iterating through list_public_operators requests.

This class thinly wraps an initial ListPublicOperatorsResponse object, and provides an __aiter__ method to iterate through its operators field.

If there are more pages, the __aiter__ method will make additional ListPublicOperators requests and continue to iterate through the operators field on the corresponding responses.

All the usual ListPublicOperatorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPublicOperatorsPager

A pager for iterating through list_public_operators requests.

This class thinly wraps an initial ListPublicOperatorsResponse object, and provides an __iter__ method to iterate through its operators field.

If there are more pages, the __iter__ method will make additional ListPublicOperators requests and continue to iterate through the operators field on the corresponding responses.

All the usual ListPublicOperatorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

StreamingServiceAsyncClient

Streaming service for receiving and sending packets.

StreamingServiceClient

Streaming service for receiving and sending packets.

StreamsServiceAsyncClient

Service describing handlers for resources. Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.

StreamsServiceClient

Service describing handlers for resources. Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.

ListClustersAsyncPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClustersPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEventsAsyncPager

A pager for iterating through list_events requests.

This class thinly wraps an initial ListEventsResponse object, and provides an __aiter__ method to iterate through its events field.

If there are more pages, the __aiter__ method will make additional ListEvents requests and continue to iterate through the events field on the corresponding responses.

All the usual ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEventsPager

A pager for iterating through list_events requests.

This class thinly wraps an initial ListEventsResponse object, and provides an __iter__ method to iterate through its events field.

If there are more pages, the __iter__ method will make additional ListEvents requests and continue to iterate through the events field on the corresponding responses.

All the usual ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSeriesAsyncPager

A pager for iterating through list_series requests.

This class thinly wraps an initial ListSeriesResponse object, and provides an __aiter__ method to iterate through its series field.

If there are more pages, the __aiter__ method will make additional ListSeries requests and continue to iterate through the series field on the corresponding responses.

All the usual ListSeriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSeriesPager

A pager for iterating through list_series requests.

This class thinly wraps an initial ListSeriesResponse object, and provides an __iter__ method to iterate through its series field.

If there are more pages, the __iter__ method will make additional ListSeries requests and continue to iterate through the series field on the corresponding responses.

All the usual ListSeriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsAsyncPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __aiter__ method to iterate through its streams field.

If there are more pages, the __aiter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __iter__ method to iterate through its streams field.

If there are more pages, the __iter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

WarehouseAsyncClient

Service that manages media content + metadata for streaming.

WarehouseClient

Service that manages media content + metadata for streaming.

ListAnnotationsAsyncPager

A pager for iterating through list_annotations requests.

This class thinly wraps an initial ListAnnotationsResponse object, and provides an __aiter__ method to iterate through its annotations field.

If there are more pages, the __aiter__ method will make additional ListAnnotations requests and continue to iterate through the annotations field on the corresponding responses.

All the usual ListAnnotationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAnnotationsPager

A pager for iterating through list_annotations requests.

This class thinly wraps an initial ListAnnotationsResponse object, and provides an __iter__ method to iterate through its annotations field.

If there are more pages, the __iter__ method will make additional ListAnnotations requests and continue to iterate through the annotations field on the corresponding responses.

All the usual ListAnnotationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsAsyncPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __aiter__ method to iterate through its assets field.

If there are more pages, the __aiter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __iter__ method to iterate through its assets field.

If there are more pages, the __iter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCollectionsAsyncPager

A pager for iterating through list_collections requests.

This class thinly wraps an initial ListCollectionsResponse object, and provides an __aiter__ method to iterate through its collections field.

If there are more pages, the __aiter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCollectionsPager

A pager for iterating through list_collections requests.

This class thinly wraps an initial ListCollectionsResponse object, and provides an __iter__ method to iterate through its collections field.

If there are more pages, the __iter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCorporaAsyncPager

A pager for iterating through list_corpora requests.

This class thinly wraps an initial ListCorporaResponse object, and provides an __aiter__ method to iterate through its corpora field.

If there are more pages, the __aiter__ method will make additional ListCorpora requests and continue to iterate through the corpora field on the corresponding responses.

All the usual ListCorporaResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCorporaPager

A pager for iterating through list_corpora requests.

This class thinly wraps an initial ListCorporaResponse object, and provides an __iter__ method to iterate through its corpora field.

If there are more pages, the __iter__ method will make additional ListCorpora requests and continue to iterate through the corpora field on the corresponding responses.

All the usual ListCorporaResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataSchemasAsyncPager

A pager for iterating through list_data_schemas requests.

This class thinly wraps an initial ListDataSchemasResponse object, and provides an __aiter__ method to iterate through its data_schemas field.

If there are more pages, the __aiter__ method will make additional ListDataSchemas requests and continue to iterate through the data_schemas field on the corresponding responses.

All the usual ListDataSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataSchemasPager

A pager for iterating through list_data_schemas requests.

This class thinly wraps an initial ListDataSchemasResponse object, and provides an __iter__ method to iterate through its data_schemas field.

If there are more pages, the __iter__ method will make additional ListDataSchemas requests and continue to iterate through the data_schemas field on the corresponding responses.

All the usual ListDataSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIndexEndpointsAsyncPager

A pager for iterating through list_index_endpoints requests.

This class thinly wraps an initial ListIndexEndpointsResponse object, and provides an __aiter__ method to iterate through its index_endpoints field.

If there are more pages, the __aiter__ method will make additional ListIndexEndpoints requests and continue to iterate through the index_endpoints field on the corresponding responses.

All the usual ListIndexEndpointsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIndexEndpointsPager

A pager for iterating through list_index_endpoints requests.

This class thinly wraps an initial ListIndexEndpointsResponse object, and provides an __iter__ method to iterate through its index_endpoints field.

If there are more pages, the __iter__ method will make additional ListIndexEndpoints requests and continue to iterate through the index_endpoints field on the corresponding responses.

All the usual ListIndexEndpointsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIndexesAsyncPager

A pager for iterating through list_indexes requests.

This class thinly wraps an initial ListIndexesResponse object, and provides an __aiter__ method to iterate through its indexes field.

If there are more pages, the __aiter__ method will make additional ListIndexes requests and continue to iterate through the indexes field on the corresponding responses.

All the usual ListIndexesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIndexesPager

A pager for iterating through list_indexes requests.

This class thinly wraps an initial ListIndexesResponse object, and provides an __iter__ method to iterate through its indexes field.

If there are more pages, the __iter__ method will make additional ListIndexes requests and continue to iterate through the indexes field on the corresponding responses.

All the usual ListIndexesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSearchConfigsAsyncPager

A pager for iterating through list_search_configs requests.

This class thinly wraps an initial ListSearchConfigsResponse object, and provides an __aiter__ method to iterate through its search_configs field.

If there are more pages, the __aiter__ method will make additional ListSearchConfigs requests and continue to iterate through the search_configs field on the corresponding responses.

All the usual ListSearchConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSearchConfigsPager

A pager for iterating through list_search_configs requests.

This class thinly wraps an initial ListSearchConfigsResponse object, and provides an __iter__ method to iterate through its search_configs field.

If there are more pages, the __iter__ method will make additional ListSearchConfigs requests and continue to iterate through the search_configs field on the corresponding responses.

All the usual ListSearchConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSearchHypernymsAsyncPager

A pager for iterating through list_search_hypernyms requests.

This class thinly wraps an initial ListSearchHypernymsResponse object, and provides an __aiter__ method to iterate through its search_hypernyms field.

If there are more pages, the __aiter__ method will make additional ListSearchHypernyms requests and continue to iterate through the search_hypernyms field on the corresponding responses.

All the usual ListSearchHypernymsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSearchHypernymsPager

A pager for iterating through list_search_hypernyms requests.

This class thinly wraps an initial ListSearchHypernymsResponse object, and provides an __iter__ method to iterate through its search_hypernyms field.

If there are more pages, the __iter__ method will make additional ListSearchHypernyms requests and continue to iterate through the search_hypernyms field on the corresponding responses.

All the usual ListSearchHypernymsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAssetsAsyncPager

A pager for iterating through search_assets requests.

This class thinly wraps an initial SearchAssetsResponse object, and provides an __aiter__ method to iterate through its search_result_items field.

If there are more pages, the __aiter__ method will make additional SearchAssets requests and continue to iterate through the search_result_items field on the corresponding responses.

All the usual SearchAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAssetsPager

A pager for iterating through search_assets requests.

This class thinly wraps an initial SearchAssetsResponse object, and provides an __iter__ method to iterate through its search_result_items field.

If there are more pages, the __iter__ method will make additional SearchAssets requests and continue to iterate through the search_result_items field on the corresponding responses.

All the usual SearchAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchIndexEndpointAsyncPager

A pager for iterating through search_index_endpoint requests.

This class thinly wraps an initial SearchIndexEndpointResponse object, and provides an __aiter__ method to iterate through its search_result_items field.

If there are more pages, the __aiter__ method will make additional SearchIndexEndpoint requests and continue to iterate through the search_result_items field on the corresponding responses.

All the usual SearchIndexEndpointResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchIndexEndpointPager

A pager for iterating through search_index_endpoint requests.

This class thinly wraps an initial SearchIndexEndpointResponse object, and provides an __iter__ method to iterate through its search_result_items field.

If there are more pages, the __iter__ method will make additional SearchIndexEndpoint requests and continue to iterate through the search_result_items field on the corresponding responses.

All the usual SearchIndexEndpointResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ViewCollectionItemsAsyncPager

A pager for iterating through view_collection_items requests.

This class thinly wraps an initial ViewCollectionItemsResponse object, and provides an __aiter__ method to iterate through its items field.

If there are more pages, the __aiter__ method will make additional ViewCollectionItems requests and continue to iterate through the items field on the corresponding responses.

All the usual ViewCollectionItemsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ViewCollectionItemsPager

A pager for iterating through view_collection_items requests.

This class thinly wraps an initial ViewCollectionItemsResponse object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional ViewCollectionItems requests and continue to iterate through the items field on the corresponding responses.

All the usual ViewCollectionItemsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ViewIndexedAssetsAsyncPager

A pager for iterating through view_indexed_assets requests.

This class thinly wraps an initial ViewIndexedAssetsResponse object, and provides an __aiter__ method to iterate through its indexed_assets field.

If there are more pages, the __aiter__ method will make additional ViewIndexedAssets requests and continue to iterate through the indexed_assets field on the corresponding responses.

All the usual ViewIndexedAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ViewIndexedAssetsPager

A pager for iterating through view_indexed_assets requests.

This class thinly wraps an initial ViewIndexedAssetsResponse object, and provides an __iter__ method to iterate through its indexed_assets field.

If there are more pages, the __iter__ method will make additional ViewIndexedAssets requests and continue to iterate through the indexed_assets field on the corresponding responses.

All the usual ViewIndexedAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AIEnabledDevicesInputConfig

Message describing AI-enabled Devices Input Config.

AcceleratorType

Represents a hardware accelerator type.

AcquireLeaseRequest

Request message for acquiring a lease.

AddApplicationStreamInputRequest

Message for adding stream input to an Application.

AddApplicationStreamInputResponse

Message for AddApplicationStreamInput Response.

AddCollectionItemRequest

Request message for AddCollectionItem.

AddCollectionItemResponse

Response message for AddCollectionItem.

Analysis

Message describing the Analysis object.

InputStreamsMappingEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

OutputStreamsMappingEntry

The abstract base class for a message.

AnalysisDefinition

Defines a full analysis.

This is a description of the overall live analytics pipeline. You may think of this as an edge list representation of a multigraph.

This may be directly authored by a human in protobuf textformat, or it may be generated by a programming API (perhaps Python or JavaScript depending on context).

AnalyzeAssetMetadata

Metadata for AnalyzeAsset.

AnalysisStatus

The status of analysis on each search capability.

State

The state of the search capability.

AnalyzeAssetRequest

Request message for AnalyzeAsset.

AnalyzeAssetResponse

Response message for AnalyzeAsset.

AnalyzeCorpusMetadata

The metadata message for AnalyzeCorpus LRO.

AnalyzeCorpusRequest

Request message for AnalyzeCorpus.

AnalyzeCorpusResponse

The response message for AnalyzeCorpus LRO.

AnalyzerDefinition

Defines an Analyzer.

An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator.

AttrsEntry

The abstract base class for a message.

DebugOptions

Options available for debugging purposes only.

EnvironmentVariablesEntry

The abstract base class for a message.

OperatorOption

Option related to the operator.

StreamInput

The inputs to this analyzer.

We accept input name references of the following form: :

Example:

Suppose you had an operator named "SomeOp" that has 2 output arguments, the first of which is named "foo" and the second of which is named "bar", and an operator named "MyOp" that accepts 2 inputs.

Also suppose that there is an analyzer named "some-analyzer" that is running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".

To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" output as its first input and "some-analyzer"'s "bar" output as its second input, you can set this field to the following: input = ["some-analyzer:foo", "some-analyzer:bar"]

Annotation

An annotation is a resource in asset. It represents a key-value mapping of content in asset.

AnnotationCustomizedStruct

Customized struct represnation in annotation.

ElementsEntry

The abstract base class for a message.

AnnotationList

List representation in annotation.

AnnotationMatchingResult

Stores the criteria-annotation matching results for each search result item.

AnnotationValue

Value of annotation, including all types available in data schema.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AppPlatformCloudFunctionRequest

For any cloud function based customer processing logic, customer's cloud function is expected to receive AppPlatformCloudFunctionRequest as request and send back AppPlatformCloudFunctionResponse as response. Message of request from AppPlatform to Cloud Function.

StructedInputAnnotation

A general annotation message that uses struct format to represent different concrete annotation protobufs.

AppPlatformCloudFunctionResponse

Message of the response from customer's Cloud Function to AppPlatform.

StructedOutputAnnotation

A general annotation message that uses struct format to represent different concrete annotation protobufs.

AppPlatformEventBody

Message of content of appPlatform event

AppPlatformMetadata

Message of essential metadata of App Platform. This message is usually attached to a certain processor output annotation for customer to identify the source of the data.

Application

Message describing Application object

ApplicationRuntimeInfo

Message storing the runtime information of the application.

GlobalOutputResource

Message about output resources from application.

MonitoringConfig

Monitoring-related configuration for an application.

BillingMode

Billing mode of the Application

LabelsEntry

The abstract base class for a message.

State

State of the Application

ApplicationConfigs

Message storing the graph of the application.

EventDeliveryConfig

message storing the config for event delivery

ApplicationInstance

Message for creating a Instance.

ApplicationNodeAnnotation

Message describing annotations specific to application node. This message is a duplication of StreamWithAnnotation.NodeAnnotation.

ApplicationStreamInput

Message about a single stream input config.

Asset

An asset is a resource in corpus. It represents a media object inside corpus, contains metadata and another resource annotation. Different feature could be applied to the asset to generate annotations. User could specified annotation related to the target asset.

AssetSource

The source of the asset.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AssetContentData

The content of the asset.

AssetGcsSource

The asset source is from Cloud Storage.

AttributeValue

Represents an actual value of an operator attribute.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AutoscalingMetricSpec

The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.

BatchOperationStatus

The batch operation status.

BatchRunProcessRequest

Request message for running the processes in a batch.

BatchRunProcessOptions

Options for batch processes.

BatchRunProcessResponse

Response message for running the processes in a batch.

BigQueryConfig

Message of configurations for BigQuery processor.

CloudFunctionMappingEntry

The abstract base class for a message.

BoolValue

Channel

Message describing the Channel object.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

CircleArea

Representation of a circle area.

ClassificationPredictionResult

Prediction output format for Image and Text Classification.

ClipAssetRequest

Request message for ClipAsset API.

ClipAssetResponse

Response message for ClipAsset API.

TimeIndexedUri

Signed uri with corresponding time range.

Cluster

Message describing the Cluster object.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

The current state of the cluster.

ClusterInfo

Collection

A collection is a resource in a corpus. It serves as a container of references to original resources.

CollectionItem

A CollectionItem is an item in a collection. Each item is a reference to the original resource in a collection.

Type

CollectionItem types.

CommitRequest

The message for explicitly committing the read progress.

This may only be used when ReceivePacketsControlledMode is set in the initial setup request.

ControlledMode

The options for receiver under the controlled mode.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Corpus

Corpus is a set of media contents for management. Within a corpus, media shares the same data schema. Search is also restricted within a single corpus.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Type

Type of the asset inside the corpus.

CreateAnalysisRequest

Message for creating an Analysis.

CreateAnnotationRequest

Request message for CreateAnnotation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateApplicationInstancesRequest

Message for adding stream input to an Application.

CreateApplicationInstancesResponse

Message for CreateApplicationInstance Response.

CreateApplicationRequest

Message for creating a Application.

CreateAssetRequest

Request message for CreateAssetRequest.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateClusterRequest

Message for creating a Cluster.

CreateCollectionMetadata

Metadata message for CreateCollectionRequest

CreateCollectionRequest

Request message for CreateCollection.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateCorpusMetadata

Metadata for CreateCorpus API.

CreateCorpusRequest

Request message of CreateCorpus API.

CreateDataSchemaRequest

Request message for CreateDataSchema.

CreateDraftRequest

Message for creating a Draft.

CreateEventRequest

Message for creating a Event.

CreateIndexEndpointMetadata

Metadata message for CreateIndexEndpoint.

CreateIndexEndpointRequest

Request message for CreateIndexEndpoint.

CreateIndexMetadata

Metadata message for CreateIndexRequest

CreateIndexRequest

Message for creating an Index.

CreateOperatorRequest

Message for creating a Operator.

CreateProcessRequest

Message for creating a Process.

CreateProcessorRequest

Message for creating a Processor.

CreateSearchConfigRequest

Request message for CreateSearchConfig.

CreateSearchHypernymRequest

Request message for creating SearchHypernym.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateSeriesRequest

Message for creating a Series.

CreateStreamRequest

Message for creating a Stream.

Criteria

Filter criteria applied to current search results.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomProcessorSourceInfo

Describes the source info for a custom processor.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalInfoEntry

The abstract base class for a message.

ModelSchema

The schema is defined as an OpenAPI 3.0.2 Schema Object <https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>__.

ProductRecognizerArtifact

Message describes product recognizer artifact.

SourceType

Source type of the imported custom processor.

DataSchema

Data schema indicates how the user specified annotation is interpreted in the system.

DataSchemaDetails

Data schema details indicates the data type and the data struct corresponding to the key of user specified annotation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomizedStructConfig

The configuration for CUSTOMIZED_STRUCT data type.

FieldSchemasEntry

The abstract base class for a message.

DataType

Data type of the annotation.

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       IntRangeArray.
FLOAT (2):
    Float type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       FloatRangeArray.
STRING (3):
    String type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH,
    -  DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME (5):
    Supported formats: %Y-%m-%dT%H:%M:%E\ *S%E*\ z
    (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E\ *S
    %Y-%m-%dT%H:%M%E*\ z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E\ *z
    %Y-%m-%dT%H %Y-%m-%d%E*\ z %Y-%m-%d %Y-%m %Y Allowed search
    strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       DateTimeRangeArray.
GEO_COORDINATE (7):
    Geo coordinate type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       GeoLocationArray.
PROTO_ANY (8):
    Type to pass any proto as available in annotations.proto.
    Only use internally. Available proto types and its
    corresponding search behavior:

    -  ImageObjectDetectionPredictionResult, allows SMART_SEARCH
       on display_names and NO_SEARCH.
    -  ClassificationPredictionResult, allows SMART_SEARCH on
       display_names and NO_SEARCH.
    -  ImageSegmentationPredictionResult, allows NO_SEARCH.
    -  VideoActionRecognitionPredictionResult, allows
       SMART_SEARCH on display_name and NO_SEARCH.
    -  VideoObjectTrackingPredictionResult, allows SMART_SEARCH
       on display_name and NO_SEARCH.
    -  VideoClassificationPredictionResult, allows SMART_SEARCH
       on display_name and NO_SEARCH.
    -  OccupancyCountingPredictionResult, allows EXACT_SEARCH on
       stats.full_frame_count.count and NO_SEARCH.
    -  ObjectDetectionPredictionResult, allows SMART_SEARCH on
       identified_boxes.entity.label_string and NO_SEARCH.
BOOLEAN (9):
    Boolean type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH.
LIST (10):
    List type.

    -  Each element in the list must be of the exact same data
       schema; otherwise, they are invalid arguments.
    -  List level cannot set search strategy. Leaf node level
       can do.
    -  Elements cannot be another list (no list of list).
    -  Elements can be CUSTOMIZED_STRUCT, and max number of
       layers is 10.
CUSTOMIZED_STRUCT (6):
    Struct type.

    -  SearchStrategy:

       -  Data Schema that's CUSTOMIZED_STRUCT cannot set search
          strategy.
       -  Leaf-node elements allow setting search strategy based
          on element's SearchStrategy restriction.

    -  Nested layer restrictions:

       -  Data Schema that's CUSTOMIZED_STRUCT allows its fields
          to be of CUSTOMIZED_STRUCT as well, but the overall
          layers restriction is 10.

Granularity

The granularity of annotations under this DataSchema.

ListConfig

The configuration for LIST data type.

ProtoAnyConfig

The configuration for PROTO_ANY data type.

SearchStrategy

The search strategy for annotations value of the key.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConfidenceScoreIndexConfig

Filter on the confidence score. Only adds to index if the confidence score is higher than the threshold. Example data schema: key: "name-confidence-pair" type: CUSTOMIZED_STRUCT granularity: GRANULARITY_PARTITION_LEVEL customized_struct_config { field_schemas { key: "name" type: STRING granularity: GRANULARITY_PARTITION_LEVEL search_strategy { search_strategy_type: SMART_SEARCH confidence_score_index_config { field_path: "name-confidence-pair.score" threshold: 0.6 } } } field_schemas { key: "score" type: FLOAT granularity: GRANULARITY_PARTITION_LEVEL } } This means only "name" with score > 0.6 will be indexed.

SearchStrategyType

The types of search strategies to be applied on the annotation key.

DataType

All supported data types.

DateTimeRange

Datetime range type.

DateTimeRangeArray

A list of datetime range values.

DedicatedResources

A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.

DeleteAnalysisRequest

Message for deleting an Analysis.

DeleteAnnotationRequest

Request message for DeleteAnnotation API.

DeleteApplicationInstancesRequest

Message for removing stream input from an Application.

DeleteApplicationInstancesResponse

Message for DeleteApplicationInstance Response.

DeleteApplicationRequest

Message for deleting an Application.

DeleteAssetMetadata

The metadata for DeleteAsset API that embeds in metadata][google.longrunning.Operation.metadata] field.

DeleteAssetRequest

Request message for DeleteAsset.

DeleteClusterRequest

Message for deleting a Cluster.

DeleteCollectionMetadata

Metadata message for DeleteCollectionRequest

DeleteCollectionRequest

Request message for DeleteCollectionRequest.

DeleteCorpusRequest

Request message for DeleteCorpus.

DeleteDataSchemaRequest

Request message for DeleteDataSchema.

DeleteDraftRequest

Message for deleting a Draft.

DeleteEventRequest

Message for deleting a Event.

DeleteIndexEndpointMetadata

Metadata message for DeleteIndexEndpoint.

DeleteIndexEndpointRequest

Request message for DeleteIndexEndpoint.

DeleteIndexMetadata

Metadata message for DeleteIndexRequest

DeleteIndexRequest

Request message for DeleteIndex.

DeleteOperatorRequest

Message for deleting a Operator

DeleteProcessRequest

Message for deleting a Process.

DeleteProcessorRequest

Message for deleting a Processor.

DeleteSearchConfigRequest

Request message for DeleteSearchConfig.

DeleteSearchHypernymRequest

Request message for deleting SearchHypernym.

DeleteSeriesRequest

Message for deleting a Series.

DeleteStreamRequest

Message for deleting a Stream.

DeployApplicationRequest

Message for deploying an Application.

DeployApplicationResponse

RPC Request Messages. Message for DeployApplication Response.

DeployIndexMetadata

Metadata message for DeployIndex.

DeployIndexRequest

Request message for DeployIndex.

DeployIndexResponse

DeployIndex response once the operation is done.

DeployedIndex

A deployment of an Index.

DeployedIndexReference

Points to a DeployedIndex.

Draft

Message describing Draft object

LabelsEntry

The abstract base class for a message.

EagerMode

The options for receiver under the eager mode.

Event

Message describing the Event object.

AnnotationsEntry

The abstract base class for a message.

Clock

Clock that will be used for joining streams.

LabelsEntry

The abstract base class for a message.

EventUpdate

The event update message.

FacetBucket

Holds the facet value, selections state, and metadata.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Range

The range of values [start, end) for which faceting is applied.

FacetBucketType

Different types for a facet bucket.

FacetGroup

A group of facet buckets to be passed back and forth between backend & frontend.

FacetProperty

Central configuration for a facet.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomRangeBucketSpec

If bucket type is CUSTOM_RANGE, specify how values are bucketized. Use integer bucket value as an example, when the endpoints are 0, 10, 100, and 1000, we will generate the following facets: [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). Notably:

• endpoints must be listed in ascending order. Otherwise, the SearchConfig API will reject the facet config.
• < 1 endpoints is an invalid spec.

DateTimeBucketSpec

If bucket type is DATE, specify how date values are bucketized.

Granularity

Granularity enum for the datetime bucket.

FixedRangeBucketSpec

If bucket type is FIXED_RANGE, specify how values are bucketized. Use FixedRangeBucketSpec when you want to create multiple buckets with equal granularities. Using integer bucket value as an example, when bucket_start = 0, bucket_granularity = 10, bucket_count = 5, this facet will be aggregated via the following buckets: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). Notably, bucket_count <= 1 is an invalid spec.

FacetValue

Definition of a single value with generic type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FloatRange

Float range type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FloatRangeArray

A list of float range values.

GcsOutputConfig

Message describing GcsOutputConfig.

GcsSource

The Google Cloud Storage location for the input content.

GeneralObjectDetectionConfig

Message of configurations for General Object Detection processor.

GenerateHlsUriRequest

Request message for GenerateHlsUri API.

GenerateHlsUriResponse

Response message for GenerateHlsUri API.

GenerateRetrievalUrlRequest

Request message for GenerateRetrievalUrl API.

GenerateRetrievalUrlResponse

Response message for GenerateRetrievalUrl API.

GenerateStreamHlsTokenRequest

Request message for getting the auth token to access the stream HLS contents.

GenerateStreamHlsTokenResponse

Response message for GenerateStreamHlsToken.

GeoCoordinate

Location Coordinate Representation

GeoLocationArray

A list of locations.

GetAnalysisRequest

Message for getting an Analysis.

GetAnnotationRequest

Request message for GetAnnotation API.

GetApplicationRequest

Message for getting a Application.

GetAssetRequest

Request message for GetAsset.

GetClusterRequest

Message for getting a Cluster.

GetCollectionRequest

Request message for GetCollectionRequest.

GetCorpusRequest

Request message for GetCorpus.

GetDataSchemaRequest

Request message for GetDataSchema.

GetDraftRequest

Message for getting a Draft.

GetEventRequest

Message for getting a Event.

GetIndexEndpointRequest

Request message for GetIndexEndpoint.

GetIndexRequest

Request message for getting an Index.

GetInstanceRequest

Message for getting a Instance.

GetOperatorRequest

Message for getting a Operator.

GetProcessRequest

Message for getting a Process.

GetProcessorRequest

Message for getting a Processor.

GetSearchConfigRequest

Request message for GetSearchConfig.

GetSearchHypernymRequest

Request message for getting SearchHypernym.

GetSeriesRequest

Message for getting a Series.

GetStreamRequest

Message for getting a Stream.

GetStreamThumbnailRequest

Message for getting the thumbnail of a Stream.

GetStreamThumbnailResponse

Message for the response of GetStreamThumbnail. The empty response message indicates the thumbnail image has been uploaded to GCS successfully.

GstreamerBufferDescriptor

The descriptor for a gstreamer buffer payload.

HealthCheckRequest

HealthCheckRequest is the request message for Check.

HealthCheckResponse

HealthCheckResponse is the response message for Check.

ImageObjectDetectionPredictionResult

Prediction output format for Image Object Detection.

ImageQuery

Image query for search endpoint request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImageSegmentationPredictionResult

Prediction output format for Image Segmentation.

ImportAssetsMetadata

The metadata message for ImportAssets LRO.

ImportAssetsRequest

The request message for ImportAssets.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportAssetsResponse

The response message for ImportAssets LRO.

Index

An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Enum representing the different states through which an Index might cycle during its lifetime.

IndexAssetMetadata

Metadata for IndexAsset.

IndexAssetRequest

Request message for IndexAsset.

IndexAssetResponse

Response message for IndexAsset.

IndexEndpoint

Message representing IndexEndpoint resource. Indexes are deployed into it.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

State

IndexEndpoint stage.

IndexedAsset

An IndexedAsset is an asset that the index is built upon.

IndexingStatus

The status of indexing for the asset.

State

State enum for this asset's indexing.

IngestAssetRequest

Request message for IngestAsset API.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Config

Configuration for the data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

VideoType

Type information for video data.

ContainerFormat

Container format of the video.

TimeIndexedData

Contains the data and the corresponding time range this data is for.

IngestAssetResponse

Response message for IngestAsset API.

Instance

Message describing Instance object Next ID: 12

InputResource

Message of input resource used in one application instance.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceType

All the supported instance types.

LabelsEntry

The abstract base class for a message.

OutputResource

Message of output resource used in one application instance.

State

State of the Instance

IntRange

Integer range type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IntRangeArray

A list of integer range values.

Lease

The lease message.

LeaseType

The lease type.

ListAnalysesRequest

Message for requesting list of Analyses

ListAnalysesResponse

Message for response to listing Analyses

ListAnnotationsRequest

Request message for GetAnnotation API.

ListAnnotationsResponse

Request message for ListAnnotations API.

ListApplicationsRequest

Message for requesting list of Applications.

ListApplicationsResponse

Message for response to listing Applications.

ListAssetsRequest

Request message for ListAssets.

ListAssetsResponse

Response message for ListAssets.

ListClustersRequest

Message for requesting list of Clusters.

ListClustersResponse

Message for response to listing Clusters.

ListCollectionsRequest

Request message for ListCollections.

ListCollectionsResponse

Response message for ListCollections.

ListCorporaRequest

Request message for ListCorpora.

ListCorporaResponse

Response message for ListCorpora.

ListDataSchemasRequest

Request message for ListDataSchemas.

ListDataSchemasResponse

Response message for ListDataSchemas.

ListDraftsRequest

Message for requesting list of Drafts.

ListDraftsResponse

Message for response to listing Drafts.

ListEventsRequest

Message for requesting list of Events.

ListEventsResponse

Message for response to listing Events.

ListIndexEndpointsRequest

Request message for ListIndexEndpoints.

ListIndexEndpointsResponse

Response message for ListIndexEndpoints.

ListIndexesRequest

Request message for listing Indexes.

ListIndexesResponse

Response message for ListIndexes.

ListInstancesRequest

Message for requesting list of Instances.

ListInstancesResponse

Message for response to listing Instances.

ListOperatorsRequest

Message for requesting list of Operators.

ListOperatorsResponse

Message for response to listing Operators.

ListPrebuiltProcessorsRequest

Request Message for listing Prebuilt Processors.

ListPrebuiltProcessorsResponse

Response Message for listing Prebuilt Processors.

ListProcessesRequest

Message for requesting list of Processes.

ListProcessesResponse

Message for response to listing Processes.

ListProcessorsRequest

Message for requesting list of Processors.

ListProcessorsResponse

Message for response to listing Processors.

ListPublicOperatorsRequest

Request message of ListPublicOperatorsRequest API.

ListPublicOperatorsResponse

Response message of ListPublicOperators API.

ListSearchConfigsRequest

Request message for ListSearchConfigs.

ListSearchConfigsResponse

Response message for ListSearchConfigs.

ListSearchHypernymsRequest

Request message for listing SearchHypernyms.

ListSearchHypernymsResponse

Response message for listing SearchHypernyms.

ListSeriesRequest

Message for requesting list of Series.

ListSeriesResponse

Message for response to listing Series.

ListStreamsRequest

Message for requesting list of Streams.

ListStreamsResponse

Message for response to listing Streams.

MachineSpec

Specification of a single machine.

MaterializeChannelRequest

Message for materializing a channel.

MediaWarehouseConfig

Message describing MediaWarehouseConfig.

ModelType

All the supported model types in Vision AI App Platform.

Node

Message describing node object.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InputEdge

Message describing one edge pointing into a node.

NormalizedPolygon

Normalized Polygon.

NormalizedPolyline

Normalized Pplyline, which represents a curve consisting of connected straight-line segments.

NormalizedVertex

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

ObjectDetectionPredictionResult

Prediction output format for Generic Object Detection.

Entity

The entity info for annotations from object detection prediction result.

IdentifiedBox

Identified box contains location and the entity of the object.

NormalizedBoundingBox

Bounding Box in the normalized coordinates.

OccupancyCountConfig

Message describing OccupancyCountConfig.

OccupancyCountingPredictionResult

The prediction result proto for occupancy counting.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DwellTimeInfo

The dwell time info for annotations from occupancy counting operator.

Entity

The entity info for annotations from occupancy counting operator.

IdentifiedBox

Identified box contains location and the entity of the object.

NormalizedBoundingBox

Bounding Box in the normalized coordinates.

Stats

The statistics info for annotations from occupancy counting operator.

AccumulatedObjectCount

The object info and accumulated count for annotations from occupancy counting operator.

ActiveZoneCount

Message for the active zone count.

CrossingLineCount

Message for Crossing line count.

ObjectCount

The object info and instant count for annotations from occupancy counting operator.

TrackInfo

The track info for annotations from occupancy counting operator.

OperationMetadata

Represents the metadata of the long-running operation.

Operator

Message describing the Operator object.

LabelsEntry

The abstract base class for a message.

OperatorDefinition

Defines the interface of an Operator.

Arguments to an operator are input/output streams that are getting processesed/returned while attributes are fixed configuration parameters.

ArgumentDefinition

Defines an argument to an operator.

Used for both inputs and outputs.

AttributeDefinition

Defines an attribute of an operator.

OperatorQuery

OperatorQuery represents one query to a Operator.

Packet

The quanta of datum that the series accepts.

PacketHeader

The message that represents packet header.

PacketType

The message that represents the data type of a packet.

TypeDescriptor

The message that fully specifies the type of the packet.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Partition

Partition to specify the partition in time and space for sub-asset level annotation.

RelativeTemporalPartition

Partition of asset in relative time. Supported by VIDEO_ON_DEMAND corpus type.

SpatialPartition

Partition of asset in space.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TemporalPartition

Partition of asset in UTC Epoch time. Supported by STREAM_VIDEO corpus type.

PersonBlurConfig

Message describing FaceBlurConfig.

PersonBlurType

Type of Person Blur

PersonVehicleDetectionConfig

Message describing PersonVehicleDetectionConfig.

PersonalProtectiveEquipmentDetectionConfig

Message describing PersonalProtectiveEquipmentDetectionConfig.

PersonalProtectiveEquipmentDetectionOutput

Output format for Personal Protective Equipment Detection Operator.

DetectedPerson

Detected Person contains the detected person and their associated ppes and their protecting information.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NormalizedBoundingBox

Bounding Box in the normalized coordinates.

PPEEntity

The entity info for annotations from PPE detection prediction result.

PPEIdentifiedBox

PPEIdentified box contains the location and the entity info of the PPE.

PersonEntity

The entity info for annotations from person detection prediction result.

PersonIdentifiedBox

PersonIdentified box contains the location and the entity info of the person.

Process

Message describing the Process object.

Processor

Message describing Processor object. Next ID: 19

LabelsEntry

The abstract base class for a message.

ProcessorState

ProcessorType

Type

ProcessorConfig

Next ID: 35

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProcessorIOSpec

Message describing the input / output specifications of a processor.

GraphInputChannelSpec

Message for input channel specification.

GraphOutputChannelSpec

Message for output channel specification.

InstanceResourceInputBindingSpec

Message for instance resource channel specification. External resources are virtual nodes which are not expressed in the application graph. Each processor expresses its out-graph spec, so customer is able to override the external source or destinations to the

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceResourceOutputBindingSpec

ProductRecognizerConfig

Message describing ProductRecognizerConfig.

RawImageDescriptor

The descriptor for a raw image.

ReceiveEventsControlResponse

Control message for a ReceiveEventsResponse.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceiveEventsRequest

Request message for ReceiveEvents.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SetupRequest

SetupRequest is the first message sent to the service to setup the RPC connection.

ReceiveEventsResponse

Response message for the ReceiveEvents.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceivePacketsControlResponse

Control message for a ReceivePacketsResponse.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceivePacketsRequest

Request message for receiving packets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SetupRequest

The message specifying the initial settings for the ReceivePackets session.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceivePacketsResponse

Response message from ReceivePackets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Registry

The enum of the types of the Registry.

ReleaseLeaseRequest

Request message for releasing lease.

ReleaseLeaseResponse

Response message for release lease.

RemoveApplicationStreamInputRequest

Message for removing stream input from an Application.

TargetStreamInput

Message about target streamInput to remove.

RemoveApplicationStreamInputResponse

Message for RemoveApplicationStreamInput Response.

RemoveCollectionItemRequest

Request message for RemoveCollectionItem.

RemoveCollectionItemResponse

Request message for RemoveCollectionItem.

RemoveIndexAssetMetadata

Metadata for RemoveIndexAsset.

RemoveIndexAssetRequest

Request message for RemoveIndexAsset.

RemoveIndexAssetResponse

Response message for RemoveIndexAsset.

RenewLeaseRequest

Request message for renewing a lease.

RequestMetadata

RequestMetadata is the metadata message for the request.

ResolveOperatorInfoRequest

Request message for querying operator info.

ResolveOperatorInfoResponse

Response message of ResolveOperatorInfo API.

ResourceAnnotations

Message describing general annotation for resources.

ResourceSpecification

ResourceSpec collects a set of resources that can be used to specify requests and requirements.

Note: Highly experimental as this can be runtime dependent. Can use the "extras" field to experiment first before trying to abstract it.

RunMode

RunMode represents the mode to launch the Process on.

RunStatus

Message describing the status of the Process.

State

State represents the running status of the Process.

SchemaKeySortingStrategy

A strategy to specify how to sort by data schema key.

Option

Option for one data schema key.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AggregateMethod

When one result has multiple values with the same key, specify which value is used to sort. By default, AGGREGATE_METHOD_LARGEST is used when results are sorted in decreasing order, AGGREGATE_METHOD_SMALLEST is used when results are sorted in incresing order.

SearchAssetsRequest

Request message for SearchAssets.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SearchAssetsResponse

Response message for SearchAssets.

SearchCapability

The capability and metadata of search capability.

Type

Capability to perform different search on assets.

SearchCapabilitySetting

Setting for search capability to enable.

SearchConfig

SearchConfig stores different properties that will affect search behaviors and search results.

SearchCriteriaProperty

Central configuration for custom search criteria.

SearchHypernym

Search resource: SearchHypernym. For example, { hypernym: "vehicle" hyponyms: ["sedan", "truck"] } This means in SMART_SEARCH mode, searching for "vehicle" will also return results with "sedan" or "truck" as annotations.

SearchIndexEndpointRequest

Request message for SearchIndexEndpoint.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SearchIndexEndpointResponse

Response message for SearchIndexEndpoint.

SearchResultItem

Search result contains asset name and corresponding time ranges.

SendPacketsRequest

Request message for sending packets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SendPacketsResponse

Response message for sending packets.

Series

Message describing the Series object.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

SeriesMetadata

The message that represents series metadata.

ServerMetadata

The message that represents server metadata.

Stream

Message describing the Stream object. The Stream and the Event resources are many to many; i.e., each Stream resource can associate to many Event resources and each Event resource can associate to many Stream resources.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

StreamAnnotation

message about annotations about Vision AI stream resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StreamAnnotationType

Enum describing all possible types of a stream annotation.

StreamAnnotations

A wrapper of repeated StreamAnnotation.

StreamWithAnnotation

Message describing Vision AI stream with application specific annotations. All the StreamAnnotation object inside this message MUST have unique id.

NodeAnnotation

Message describing annotations specific to application node.

StringArray

A list of string-type values.

TagParsingConfig

Configuration for tag parsing.

EntityParsingConfig

Configuration for parsing a tag entity class.

EntityMatchingStrategy

Type of entity matching strategy.

TagRecognizerConfig

Message describing TagRecognizerConfig.

UndeployApplicationRequest

Message for undeploying an Application.

UndeployApplicationResponse

Message for UndeployApplication Response.

UndeployIndexMetadata

Metadata message for UndeployIndex.

UndeployIndexRequest

Request message for UndeployIndexEndpoint.

UndeployIndexResponse

UndeployIndex response once the operation is done.

UniversalInputConfig

Message describing UniversalInputConfig.

UpdateAnalysisRequest

Message for updating an Analysis.

UpdateAnnotationRequest

Request message for UpdateAnnotation API.

UpdateApplicationInstancesRequest

Message for updating an ApplicationInstance.

UpdateApplicationInstance

UpdateApplicationInstancesResponse

Message for UpdateApplicationInstances Response.

UpdateApplicationRequest

Message for updating an Application.

UpdateApplicationStreamInputRequest

Message for updating stream input to an Application.

UpdateApplicationStreamInputResponse

Message for AddApplicationStreamInput Response.

UpdateAssetRequest

Request message for UpdateAsset.

UpdateClusterRequest

Message for updating a Cluster.

UpdateCollectionRequest

Request message for UpdateCollectionRequest.

UpdateCorpusRequest

Request message for UpdateCorpus.

UpdateDataSchemaRequest

Request message for UpdateDataSchema.

UpdateDraftRequest

Message for updating a Draft.

UpdateEventRequest

Message for updating a Event.

UpdateIndexEndpointMetadata

Metadata message for UpdateIndexEndpoint.

UpdateIndexEndpointRequest

Request message for UpdateIndexEndpoint.

UpdateIndexMetadata

Metadata message for UpdateIndexRequest

UpdateIndexRequest

Request message for UpdateIndex.

UpdateOperatorRequest

Message for updating a Operator.

UpdateProcessRequest

Message for updating a Process.

UpdateProcessorRequest

Message for updating a Processor.

UpdateSearchConfigRequest

Request message for UpdateSearchConfig.

UpdateSearchHypernymRequest

Request message for updating SearchHypernym.

UpdateSeriesRequest

Message for updating a Series.

UpdateStreamRequest

Message for updating a Stream.

UploadAssetMetadata

Metadata for UploadAsset.

UploadAssetRequest

Request message for UploadAsset.

UploadAssetResponse

Response message for UploadAsset.

UserSpecifiedAnnotation

Annotation provided by users.

VertexAutoMLVideoConfig

Message describing VertexAutoMLVideoConfig.

VertexAutoMLVisionConfig

Message of configurations of Vertex AutoML Vision Processors.

VertexCustomConfig

Message describing VertexCustomConfig.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

VideoActionRecognitionPredictionResult

Prediction output format for Video Action Recognition.

IdentifiedAction

Each IdentifiedAction is one particular identification of an action specified with the AnnotationSpec id, display_name and the associated confidence score.

VideoClassificationPredictionResult

Prediction output format for Video Classification.

IdentifiedClassification

Each IdentifiedClassification is one particular identification of an classification specified with the AnnotationSpec id and display_name, and the associated confidence score.

VideoObjectTrackingPredictionResult

Prediction output format for Video Object Tracking.

BoundingBox

Boundingbox for detected object. I.e. the rectangle over the video frame pinpointing the found AnnotationSpec. The coordinates are relative to the frame size, and the point 0,0 is in the top left of the frame.

DetectedObject

Each DetectedObject is one particular identification of an object specified with the AnnotationSpec id and display_name, the bounding box, the associated confidence score and the corresponding track_id.

VideoStreamInputConfig

Message describing Video Stream Input Config. This message should only be used as a placeholder for builtin:stream-input processor, actual stream binding should be specified using corresponding API.

ViewCollectionItemsRequest

Request message for ViewCollectionItems.

ViewCollectionItemsResponse

Response message for ViewCollectionItems.

ViewIndexedAssetsRequest

Request message for ViewIndexedAssets.

ViewIndexedAssetsResponse

Response message for ViewIndexedAssets.

AppPlatformAsyncClient

Service describing handlers for resources

AppPlatformClient

Service describing handlers for resources

ListApplicationsAsyncPager

A pager for iterating through list_applications requests.

This class thinly wraps an initial ListApplicationsResponse object, and provides an __aiter__ method to iterate through its applications field.

If there are more pages, the __aiter__ method will make additional ListApplications requests and continue to iterate through the applications field on the corresponding responses.

All the usual ListApplicationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListApplicationsPager

A pager for iterating through list_applications requests.

This class thinly wraps an initial ListApplicationsResponse object, and provides an __iter__ method to iterate through its applications field.

If there are more pages, the __iter__ method will make additional ListApplications requests and continue to iterate through the applications field on the corresponding responses.

All the usual ListApplicationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDraftsAsyncPager

A pager for iterating through list_drafts requests.

This class thinly wraps an initial ListDraftsResponse object, and provides an __aiter__ method to iterate through its drafts field.

If there are more pages, the __aiter__ method will make additional ListDrafts requests and continue to iterate through the drafts field on the corresponding responses.

All the usual ListDraftsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDraftsPager

A pager for iterating through list_drafts requests.

This class thinly wraps an initial ListDraftsResponse object, and provides an __iter__ method to iterate through its drafts field.

If there are more pages, the __iter__ method will make additional ListDrafts requests and continue to iterate through the drafts field on the corresponding responses.

All the usual ListDraftsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInstancesAsyncPager

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __aiter__ method to iterate through its instances field.

If there are more pages, the __aiter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInstancesPager

A pager for iterating through list_instances requests.

This class thinly wraps an initial ListInstancesResponse object, and provides an __iter__ method to iterate through its instances field.

If there are more pages, the __iter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProcessorsAsyncPager

A pager for iterating through list_processors requests.

This class thinly wraps an initial ListProcessorsResponse object, and provides an __aiter__ method to iterate through its processors field.

If there are more pages, the __aiter__ method will make additional ListProcessors requests and continue to iterate through the processors field on the corresponding responses.

All the usual ListProcessorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProcessorsPager

A pager for iterating through list_processors requests.

This class thinly wraps an initial ListProcessorsResponse object, and provides an __iter__ method to iterate through its processors field.

If there are more pages, the __iter__ method will make additional ListProcessors requests and continue to iterate through the processors field on the corresponding responses.

All the usual ListProcessorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

LiveVideoAnalyticsAsyncClient

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

LiveVideoAnalyticsClient

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

ListAnalysesAsyncPager

A pager for iterating through list_analyses requests.

This class thinly wraps an initial ListAnalysesResponse object, and provides an __aiter__ method to iterate through its analyses field.

If there are more pages, the __aiter__ method will make additional ListAnalyses requests and continue to iterate through the analyses field on the corresponding responses.

All the usual ListAnalysesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAnalysesPager

A pager for iterating through list_analyses requests.

This class thinly wraps an initial ListAnalysesResponse object, and provides an __iter__ method to iterate through its analyses field.

If there are more pages, the __iter__ method will make additional ListAnalyses requests and continue to iterate through the analyses field on the corresponding responses.

All the usual ListAnalysesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

StreamingServiceAsyncClient

Streaming service for receiving and sending packets.

StreamingServiceClient

Streaming service for receiving and sending packets.

StreamsServiceAsyncClient

Service describing handlers for resources. Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.

StreamsServiceClient

Service describing handlers for resources. Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.

ListClustersAsyncPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClustersPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEventsAsyncPager

A pager for iterating through list_events requests.

This class thinly wraps an initial ListEventsResponse object, and provides an __aiter__ method to iterate through its events field.

If there are more pages, the __aiter__ method will make additional ListEvents requests and continue to iterate through the events field on the corresponding responses.

All the usual ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEventsPager

A pager for iterating through list_events requests.

This class thinly wraps an initial ListEventsResponse object, and provides an __iter__ method to iterate through its events field.

If there are more pages, the __iter__ method will make additional ListEvents requests and continue to iterate through the events field on the corresponding responses.

All the usual ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSeriesAsyncPager

A pager for iterating through list_series requests.

This class thinly wraps an initial ListSeriesResponse object, and provides an __aiter__ method to iterate through its series field.

If there are more pages, the __aiter__ method will make additional ListSeries requests and continue to iterate through the series field on the corresponding responses.

All the usual ListSeriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSeriesPager

A pager for iterating through list_series requests.

This class thinly wraps an initial ListSeriesResponse object, and provides an __iter__ method to iterate through its series field.

If there are more pages, the __iter__ method will make additional ListSeries requests and continue to iterate through the series field on the corresponding responses.

All the usual ListSeriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsAsyncPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __aiter__ method to iterate through its streams field.

If there are more pages, the __aiter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __iter__ method to iterate through its streams field.

If there are more pages, the __iter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

WarehouseAsyncClient

Service that manages media content + metadata for streaming.

WarehouseClient

Service that manages media content + metadata for streaming.

ListAnnotationsAsyncPager

A pager for iterating through list_annotations requests.

This class thinly wraps an initial ListAnnotationsResponse object, and provides an __aiter__ method to iterate through its annotations field.

If there are more pages, the __aiter__ method will make additional ListAnnotations requests and continue to iterate through the annotations field on the corresponding responses.

All the usual ListAnnotationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAnnotationsPager

A pager for iterating through list_annotations requests.

This class thinly wraps an initial ListAnnotationsResponse object, and provides an __iter__ method to iterate through its annotations field.

If there are more pages, the __iter__ method will make additional ListAnnotations requests and continue to iterate through the annotations field on the corresponding responses.

All the usual ListAnnotationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsAsyncPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __aiter__ method to iterate through its assets field.

If there are more pages, the __aiter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __iter__ method to iterate through its assets field.

If there are more pages, the __iter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCorporaAsyncPager

A pager for iterating through list_corpora requests.

This class thinly wraps an initial ListCorporaResponse object, and provides an __aiter__ method to iterate through its corpora field.

If there are more pages, the __aiter__ method will make additional ListCorpora requests and continue to iterate through the corpora field on the corresponding responses.

All the usual ListCorporaResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCorporaPager

A pager for iterating through list_corpora requests.

This class thinly wraps an initial ListCorporaResponse object, and provides an __iter__ method to iterate through its corpora field.

If there are more pages, the __iter__ method will make additional ListCorpora requests and continue to iterate through the corpora field on the corresponding responses.

All the usual ListCorporaResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataSchemasAsyncPager

A pager for iterating through list_data_schemas requests.

This class thinly wraps an initial ListDataSchemasResponse object, and provides an __aiter__ method to iterate through its data_schemas field.

If there are more pages, the __aiter__ method will make additional ListDataSchemas requests and continue to iterate through the data_schemas field on the corresponding responses.

All the usual ListDataSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataSchemasPager

A pager for iterating through list_data_schemas requests.

This class thinly wraps an initial ListDataSchemasResponse object, and provides an __iter__ method to iterate through its data_schemas field.

If there are more pages, the __iter__ method will make additional ListDataSchemas requests and continue to iterate through the data_schemas field on the corresponding responses.

All the usual ListDataSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSearchConfigsAsyncPager

A pager for iterating through list_search_configs requests.

This class thinly wraps an initial ListSearchConfigsResponse object, and provides an __aiter__ method to iterate through its search_configs field.

If there are more pages, the __aiter__ method will make additional ListSearchConfigs requests and continue to iterate through the search_configs field on the corresponding responses.

All the usual ListSearchConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSearchConfigsPager

A pager for iterating through list_search_configs requests.

This class thinly wraps an initial ListSearchConfigsResponse object, and provides an __iter__ method to iterate through its search_configs field.

If there are more pages, the __iter__ method will make additional ListSearchConfigs requests and continue to iterate through the search_configs field on the corresponding responses.

All the usual ListSearchConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAssetsAsyncPager

A pager for iterating through search_assets requests.

This class thinly wraps an initial SearchAssetsResponse object, and provides an __aiter__ method to iterate through its search_result_items field.

If there are more pages, the __aiter__ method will make additional SearchAssets requests and continue to iterate through the search_result_items field on the corresponding responses.

All the usual SearchAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchAssetsPager

A pager for iterating through search_assets requests.

This class thinly wraps an initial SearchAssetsResponse object, and provides an __iter__ method to iterate through its search_result_items field.

If there are more pages, the __iter__ method will make additional SearchAssets requests and continue to iterate through the search_result_items field on the corresponding responses.

All the usual SearchAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AIEnabledDevicesInputConfig

Message describing AI-enabled Devices Input Config.

AcceleratorType

Represents a hardware accelerator type.

AcquireLeaseRequest

Request message for acquiring a lease.

AddApplicationStreamInputRequest

Message for adding stream input to an Application.

AddApplicationStreamInputResponse

Message for AddApplicationStreamInput Response.

Analysis

Message describing the Analysis object.

InputStreamsMappingEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

OutputStreamsMappingEntry

The abstract base class for a message.

AnalysisDefinition

Defines a full analysis.

This is a description of the overall live analytics pipeline. You may think of this as an edge list representation of a multigraph.

This may be directly authored by a human in protobuf textformat, or it may be generated by a programming API (perhaps Python or JavaScript depending on context).

AnalyzerDefinition

Defines an Analyzer.

An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator.

AttrsEntry

The abstract base class for a message.

DebugOptions

Options available for debugging purposes only.

EnvironmentVariablesEntry

The abstract base class for a message.

StreamInput

The inputs to this analyzer.

We accept input name references of the following form: :

Example:

Suppose you had an operator named "SomeOp" that has 2 output arguments, the first of which is named "foo" and the second of which is named "bar", and an operator named "MyOp" that accepts 2 inputs.

Also suppose that there is an analyzer named "some-analyzer" that is running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".

To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" output as its first input and "some-analyzer"'s "bar" output as its second input, you can set this field to the following: input = ["some-analyzer:foo", "some-analyzer:bar"]

Annotation

An annotation is a resource in asset. It represents a key-value mapping of content in asset.

AnnotationMatchingResult

Stores the criteria-annotation matching results for each search result item.

AnnotationValue

Value of annotation, including all types available in data schema.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AppPlatformCloudFunctionRequest

For any cloud function based customer processing logic, customer's cloud function is expected to receive AppPlatformCloudFunctionRequest as request and send back AppPlatformCloudFunctionResponse as response. Message of request from AppPlatform to Cloud Function.

StructedInputAnnotation

A general annotation message that uses struct format to represent different concrete annotation protobufs.

AppPlatformCloudFunctionResponse

Message of the response from customer's Cloud Function to AppPlatform.

StructedOutputAnnotation

A general annotation message that uses struct format to represent different concrete annotation protobufs.

AppPlatformEventBody

Message of content of appPlatform event

AppPlatformMetadata

Message of essential metadata of App Platform. This message is usually attached to a certain processor output annotation for customer to identify the source of the data.

Application

Message describing Application object

ApplicationRuntimeInfo

Message storing the runtime information of the application.

GlobalOutputResource

Message about output resources from application.

MonitoringConfig

Monitoring-related configuration for an application.

LabelsEntry

The abstract base class for a message.

State

State of the Application

ApplicationConfigs

Message storing the graph of the application.

EventDeliveryConfig

message storing the config for event delivery

ApplicationInstance

Message for creating a Instance.

ApplicationNodeAnnotation

Message describing annotations specific to application node. This message is a duplication of StreamWithAnnotation.NodeAnnotation.

ApplicationStreamInput

Message about a single stream input config.

Asset

An asset is a resource in corpus. It represents a media object inside corpus, contains metadata and another resource annotation. Different feature could be applied to the asset to generate annotations. User could specified annotation related to the target asset.

AttributeValue

Represents an actual value of an operator attribute.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AutoscalingMetricSpec

The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.

BigQueryConfig

Message of configurations for BigQuery processor.

CloudFunctionMappingEntry

The abstract base class for a message.

BoolValue

Channel

Message describing the Channel object.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

CircleArea

Representation of a circle area.

ClassificationPredictionResult

Prediction output format for Image and Text Classification.

ClipAssetRequest

Request message for ClipAsset API.

ClipAssetResponse

Response message for ClipAsset API.

TimeIndexedUri

Signed uri with corresponding time range.

Cluster

Message describing the Cluster object.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

The current state of the cluster.

CommitRequest

The message for explicitly committing the read progress.

This may only be used when ReceivePacketsControlledMode is set in the initial setup request.

ControlledMode

The options for receiver under the controlled mode.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Corpus

Corpus is a set of video contents for management. Within a corpus, videos share the same data schema. Search is also restricted within a single corpus.

CreateAnalysisRequest

Message for creating an Analysis.

CreateAnnotationRequest

Request message for CreateAnnotation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateApplicationInstancesRequest

Message for adding stream input to an Application.

CreateApplicationInstancesResponse

Message for CreateApplicationInstance Response.

CreateApplicationRequest

Message for creating a Application.

CreateAssetRequest

Request message for CreateAssetRequest.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateClusterRequest

Message for creating a Cluster.

CreateCorpusMetadata

Metadata for CreateCorpus API.

CreateCorpusRequest

Request message of CreateCorpus API.

CreateDataSchemaRequest

Request message for CreateDataSchema.

CreateDraftRequest

Message for creating a Draft.

CreateEventRequest

Message for creating a Event.

CreateProcessorRequest

Message for creating a Processor.

CreateSearchConfigRequest

Request message for CreateSearchConfig.

CreateSeriesRequest

Message for creating a Series.

CreateStreamRequest

Message for creating a Stream.

Criteria

Filter criteria applied to current search results.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomProcessorSourceInfo

Describes the source info for a custom processor.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalInfoEntry

The abstract base class for a message.

ModelSchema

The schema is defined as an OpenAPI 3.0.2 Schema Object <https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>__.

SourceType

Source type of the imported custom processor.

DataSchema

Data schema indicates how the user specified annotation is interpreted in the system.

DataSchemaDetails

Data schema details indicates the data type and the data struct corresponding to the key of user specified annotation.

DataType

Data type of the annotation.

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       IntRangeArray.
FLOAT (2):
    Float type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       FloatRangeArray.
STRING (3):
    String type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH,
    -  DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME (5):
    Supported formats: %Y-%m-%dT%H:%M:%E\ *S%E*\ z
    (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E\ *S
    %Y-%m-%dT%H:%M%E*\ z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E\ *z
    %Y-%m-%dT%H %Y-%m-%d%E*\ z %Y-%m-%d %Y-%m %Y Allowed search
    strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       DateTimeRangeArray.
GEO_COORDINATE (7):
    Geo coordinate type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       GeoLocationArray.
PROTO_ANY (8):
    Type to pass any proto as available in annotations.proto.
    Only use internally. Available proto types and its
    corresponding search behavior:

    -  ImageObjectDetectionPredictionResult, allows SMART_SEARCH
       on display_names and NO_SEARCH.
    -  ClassificationPredictionResult, allows SMART_SEARCH on
       display_names and NO_SEARCH.
    -  ImageSegmentationPredictionResult, allows NO_SEARCH.
    -  VideoActionRecognitionPredictionResult, allows
       SMART_SEARCH on display_name and NO_SEARCH.
    -  VideoObjectTrackingPredictionResult, allows SMART_SEARCH
       on display_name and NO_SEARCH.
    -  VideoClassificationPredictionResult, allows SMART_SEARCH
       on display_name and NO_SEARCH.
    -  OccupancyCountingPredictionResult, allows EXACT_SEARCH on
       stats.full_frame_count.count and NO_SEARCH.
    -  ObjectDetectionPredictionResult, allows SMART_SEARCH on
       identified_boxes.entity.label_string and NO_SEARCH.
BOOLEAN (9):
    Boolean type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH.

Granularity

The granularity of annotations under this DataSchema.

ProtoAnyConfig

The configuration for PROTO_ANY data type.

SearchStrategy

The search strategy for annotations value of the key.

SearchStrategyType

The types of search strategies to be applied on the annotation key.

DateTimeRange

Datetime range type.

DateTimeRangeArray

A list of datetime range values.

DedicatedResources

A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.

DeleteAnalysisRequest

Message for deleting an Analysis.

DeleteAnnotationRequest

Request message for DeleteAnnotation API.

DeleteApplicationInstancesRequest

Message for removing stream input from an Application.

DeleteApplicationInstancesResponse

Message for DeleteApplicationInstance Response.

DeleteApplicationRequest

Message for deleting an Application.

DeleteAssetMetadata

The metadata for DeleteAsset API that embeds in metadata][google.longrunning.Operation.metadata] field.

DeleteAssetRequest

Request message for DeleteAsset.

DeleteClusterRequest

Message for deleting a Cluster.

DeleteCorpusRequest

Request message for DeleteCorpus.

DeleteDataSchemaRequest

Request message for DeleteDataSchema.

DeleteDraftRequest

Message for deleting an Draft.

DeleteEventRequest

Message for deleting a Event.

DeleteProcessorRequest

Message for deleting a Processor.

DeleteSearchConfigRequest

Request message for DeleteSearchConfig.

DeleteSeriesRequest

Message for deleting a Series.

DeleteStreamRequest

Message for deleting a Stream.

DeployApplicationRequest

Message for deploying an Application.

DeployApplicationResponse

RPC Request Messages. Message for DeployApplication Response.

Draft

Message describing Draft object

LabelsEntry

The abstract base class for a message.

EagerMode

The options for receiver under the eager mode.

Event

Message describing the Event object.

AnnotationsEntry

The abstract base class for a message.

Clock

Clock that will be used for joining streams.

LabelsEntry

The abstract base class for a message.

EventUpdate

The event update message.

FacetBucket

Holds the facet value, selections state, and metadata.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Range

The range of values [start, end) for which faceting is applied.

FacetBucketType

Different types for a facet bucket.

FacetGroup

A group of facet buckets to be passed back and forth between backend & frontend.

FacetProperty

Central configuration for a facet.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CustomRangeBucketSpec

If bucket type is CUSTOM_RANGE, specify how values are bucketized. Use integer bucket value as an example, when the endpoints are 0, 10, 100, and 1000, we will generate the following facets: [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). Notably:

• endpoints must be listed in ascending order. Otherwise, the SearchConfig API will reject the facet config.
• < 1 endpoints is an invalid spec.

DateTimeBucketSpec

If bucket type is DATE, specify how date values are bucketized.

Granularity

Granularity enum for the datetime bucket.

FixedRangeBucketSpec

If bucket type is FIXED_RANGE, specify how values are bucketized. Use FixedRangeBucketSpec when you want to create multiple buckets with equal granularities. Using integer bucket value as an example, when bucket_start = 0, bucket_granularity = 10, bucket_count = 5, this facet will be aggregated via the following buckets: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). Notably, bucket_count <= 1 is an invalid spec.

FacetValue

Definition of a single value with generic type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FloatRange

Float range type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FloatRangeArray

A list of float range values.

GcsSource

The Google Cloud Storage location for the input content.

GeneralObjectDetectionConfig

Message of configurations for General Object Detection processor.

GenerateHlsUriRequest

Request message for GenerateHlsUri API.

GenerateHlsUriResponse

Response message for GenerateHlsUri API.

GenerateStreamHlsTokenRequest

Request message for getting the auth token to access the stream HLS contents.

GenerateStreamHlsTokenResponse

Response message for GenerateStreamHlsToken.

GeoCoordinate

Location Coordinate Representation

GeoLocationArray

A list of locations.

GetAnalysisRequest

Message for getting an Analysis.

GetAnnotationRequest

Request message for GetAnnotation API.

GetApplicationRequest

Message for getting a Application.

GetAssetRequest

Request message for GetAsset.

GetClusterRequest

Message for getting a Cluster.

GetCorpusRequest

Request message for GetCorpus.

GetDataSchemaRequest

Request message for GetDataSchema.

GetDraftRequest

Message for getting a Draft.

GetEventRequest

Message for getting a Event.

GetInstanceRequest

Message for getting a Instance.

GetProcessorRequest

Message for getting a Processor.

GetSearchConfigRequest

Request message for GetSearchConfig.

GetSeriesRequest

Message for getting a Series.

GetStreamRequest

Message for getting a Stream.

GetStreamThumbnailResponse

Message for the response of GetStreamThumbnail. The empty response message indicates the thumbnail image has been uploaded to GCS successfully.

GstreamerBufferDescriptor

The descriptor for a gstreamer buffer payload.

ImageObjectDetectionPredictionResult

Prediction output format for Image Object Detection.

ImageSegmentationPredictionResult

Prediction output format for Image Segmentation.

IngestAssetRequest

Request message for IngestAsset API.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Config

Configuration for the data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

VideoType

Type information for video data.

ContainerFormat

Container format of the video.

TimeIndexedData

Contains the data and the corresponding time range this data is for.

IngestAssetResponse

Response message for IngestAsset API.

Instance

Message describing Instance object

InputResource

Message of input resource used in one application instance.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

OutputResource

Message of output resource used in one application instance.

State

State of the Instance

IntRange

Integer range type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IntRangeArray

A list of integer range values.

Lease

The lease message.

LeaseType

The lease type.

ListAnalysesRequest

Message for requesting list of Analyses

ListAnalysesResponse

Message for response to listing Analyses

ListAnnotationsRequest

Request message for GetAnnotation API.

ListAnnotationsResponse

Request message for ListAnnotations API.

ListApplicationsRequest

Message for requesting list of Applications.

ListApplicationsResponse

Message for response to listing Applications.

ListAssetsRequest

Request message for ListAssets.

ListAssetsResponse

Response message for ListAssets.

ListClustersRequest

Message for requesting list of Clusters.

ListClustersResponse

Message for response to listing Clusters.

ListCorporaRequest

Request message for ListCorpora.

ListCorporaResponse

Response message for ListCorpora.

ListDataSchemasRequest

Request message for ListDataSchemas.

ListDataSchemasResponse

Response message for ListDataSchemas.

ListDraftsRequest

Message for requesting list of Drafts.

ListDraftsResponse

Message for response to listing Drafts.

ListEventsRequest

Message for requesting list of Events.

ListEventsResponse

Message for response to listing Events.

ListInstancesRequest

Message for requesting list of Instances.

ListInstancesResponse

Message for response to listing Instances.

ListPrebuiltProcessorsRequest

Request Message for listing Prebuilt Processors.

ListPrebuiltProcessorsResponse

Response Message for listing Prebuilt Processors.

ListProcessorsRequest

Message for requesting list of Processors.

ListProcessorsResponse

Message for response to listing Processors.

ListSearchConfigsRequest

Request message for ListSearchConfigs.

ListSearchConfigsResponse

Response message for ListSearchConfigs.

ListSeriesRequest

Message for requesting list of Series.

ListSeriesResponse

Message for response to listing Series.

ListStreamsRequest

Message for requesting list of Streams.

ListStreamsResponse

Message for response to listing Streams.

MachineSpec

Specification of a single machine.

MaterializeChannelRequest

Message for materializing a channel.

MediaWarehouseConfig

Message describing MediaWarehouseConfig.

ModelType

All the supported model types in Vision AI App Platform.

Node

Message describing node object.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InputEdge

Message describing one edge pointing into a node.

NormalizedPolygon

Normalized Polygon.

NormalizedPolyline

Normalized Pplyline, which represents a curve consisting of connected straight-line segments.

NormalizedVertex

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

ObjectDetectionPredictionResult

Prediction output format for Generic Object Detection.

Entity

The entity info for annotations from object detection prediction result.

IdentifiedBox

Identified box contains location and the entity of the object.

NormalizedBoundingBox

Bounding Box in the normalized coordinates.

OccupancyCountConfig

Message describing OccupancyCountConfig.

OccupancyCountingPredictionResult

The prediction result proto for occupancy counting.

DwellTimeInfo

The dwell time info for annotations from occupancy counting operator.

Entity

The entity info for annotations from occupancy counting operator.

IdentifiedBox

Identified box contains location and the entity of the object.

NormalizedBoundingBox

Bounding Box in the normalized coordinates.

Stats

The statistics info for annotations from occupancy counting operator.

AccumulatedObjectCount

The object info and accumulated count for annotations from occupancy counting operator.

ActiveZoneCount

Message for the active zone count.

CrossingLineCount

Message for Crossing line count.

ObjectCount

The object info and instant count for annotations from occupancy counting operator.

TrackInfo

The track info for annotations from occupancy counting operator.

OperationMetadata

Represents the metadata of the long-running operation.

Packet

The quanta of datum that the series accepts.

PacketHeader

The message that represents packet header.

PacketType

The message that represents the data type of a packet.

TypeDescriptor

The message that fully specifies the type of the packet.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Partition

Partition to specify the partition in time and space for sub-asset level annotation.

SpatialPartition

Partition of asset in space.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TemporalPartition

Partition of asset in UTC Epoch time.

PersonBlurConfig

Message describing FaceBlurConfig.

PersonBlurType

Type of Person Blur

PersonVehicleDetectionConfig

Message describing PersonVehicleDetectionConfig.

PersonalProtectiveEquipmentDetectionConfig

Message describing PersonalProtectiveEquipmentDetectionConfig.

PersonalProtectiveEquipmentDetectionOutput

Output format for Personal Protective Equipment Detection Operator.

DetectedPerson

Detected Person contains the detected person and their associated ppes and their protecting information.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NormalizedBoundingBox

Bounding Box in the normalized coordinates.

PPEEntity

The entity info for annotations from PPE detection prediction result.

PPEIdentifiedBox

PPEIdentified box contains the location and the entity info of the PPE.

PersonEntity

The entity info for annotations from person detection prediction result.

PersonIdentifiedBox

PersonIdentified box contains the location and the entity info of the person.

Processor

Message describing Processor object. Next ID: 18

LabelsEntry

The abstract base class for a message.

ProcessorState

ProcessorType

Type

ProcessorConfig

Next ID: 24

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProcessorIOSpec

Message describing the input / output specifications of a processor.

DataType

High level data types supported by the processor.

GraphInputChannelSpec

Message for input channel specification.

GraphOutputChannelSpec

Message for output channel specification.

InstanceResourceInputBindingSpec

Message for instance resource channel specification. External resources are virtual nodes which are not expressed in the application graph. Each processor expresses its out-graph spec, so customer is able to override the external source or destinations to the

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceResourceOutputBindingSpec

RawImageDescriptor

The descriptor for a raw image.

ReceiveEventsControlResponse

Control message for a ReceiveEventsResponse.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceiveEventsRequest

Request message for ReceiveEvents.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SetupRequest

SetupRequest is the first message sent to the service to setup the RPC connection.

ReceiveEventsResponse

Response message for the ReceiveEvents.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceivePacketsControlResponse

Control message for a ReceivePacketsResponse.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceivePacketsRequest

Request message for receiving packets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SetupRequest

The message specifying the initial settings for the ReceivePackets session.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceivePacketsResponse

Response message from ReceivePackets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReleaseLeaseRequest

Request message for releasing lease.

ReleaseLeaseResponse

Response message for release lease.

RemoveApplicationStreamInputRequest

Message for removing stream input from an Application.

TargetStreamInput

Message about target streamInput to remove.

RemoveApplicationStreamInputResponse

Message for RemoveApplicationStreamInput Response.

RenewLeaseRequest

Request message for renewing a lease.

RequestMetadata

RequestMetadata is the metadata message for the request.

ResourceAnnotations

Message describing general annotation for resources.

SearchAssetsRequest

Request message for SearchAssets.

SearchAssetsResponse

Response message for SearchAssets.

SearchConfig

SearchConfig stores different properties that will affect search behaviors and search results.

SearchCriteriaProperty

Central configuration for custom search criteria.

SearchResultItem

Search result contains asset name and corresponding time ranges.

SendPacketsRequest

Request message for sending packets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SendPacketsResponse

Response message for sending packets.

Series

Message describing the Series object.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

SeriesMetadata

The message that represents series metadata.

ServerMetadata

The message that represents server metadata.

Stream

Message describing the Stream object. The Stream and the Event resources are many to many; i.e., each Stream resource can associate to many Event resources and each Event resource can associate to many Stream resources.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

StreamAnnotation

message about annotations about Vision AI stream resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StreamAnnotationType

Enum describing all possible types of a stream annotation.

StreamAnnotations

A wrapper of repeated StreamAnnotation.

StreamWithAnnotation

Message describing Vision AI stream with application specific annotations. All the StreamAnnotation object inside this message MUST have unique id.

NodeAnnotation

Message describing annotations specific to application node.

StringArray

A list of string-type values.

UndeployApplicationRequest

Message for undeploying an Application.

UndeployApplicationResponse

Message for UndeployApplication Response.

UpdateAnalysisRequest

Message for updating an Analysis.

UpdateAnnotationRequest

Request message for UpdateAnnotation API.

UpdateApplicationInstancesRequest

Message for updating an ApplicationInstance.

UpdateApplicationInstance

UpdateApplicationInstancesResponse

Message for UpdateApplicationInstances Response.

UpdateApplicationRequest

Message for updating an Application.

UpdateApplicationStreamInputRequest

Message for updating stream input to an Application.

UpdateApplicationStreamInputResponse

Message for AddApplicationStreamInput Response.

UpdateAssetRequest

Response message for UpdateAsset.

UpdateClusterRequest

Message for updating a Cluster.

UpdateCorpusRequest

Request message for UpdateCorpus.

UpdateDataSchemaRequest

Request message for UpdateDataSchema.

UpdateDraftRequest

Message for updating an Draft.

UpdateEventRequest

Message for updating a Event.

UpdateProcessorRequest

Message for updating a Processor.

UpdateSearchConfigRequest

Request message for UpdateSearchConfig.

UpdateSeriesRequest

Message for updating a Series.

UpdateStreamRequest

Message for updating a Stream.

UserSpecifiedAnnotation

Annotation provided by users.

VertexAutoMLVideoConfig

Message describing VertexAutoMLVideoConfig.

VertexAutoMLVisionConfig

Message of configurations of Vertex AutoML Vision Processors.

VertexCustomConfig

Message describing VertexCustomConfig.

VideoActionRecognitionPredictionResult

Prediction output format for Video Action Recognition.

IdentifiedAction

Each IdentifiedAction is one particular identification of an action specified with the AnnotationSpec id, display_name and the associated confidence score.

VideoClassificationPredictionResult

Prediction output format for Video Classification.

IdentifiedClassification

Each IdentifiedClassification is one particular identification of an classification specified with the AnnotationSpec id and display_name, and the associated confidence score.

VideoObjectTrackingPredictionResult

Prediction output format for Video Object Tracking.

BoundingBox

Boundingbox for detected object. I.e. the rectangle over the video frame pinpointing the found AnnotationSpec. The coordinates are relative to the frame size, and the point 0,0 is in the top left of the frame.

DetectedObject

Each DetectedObject is one particular identification of an object specified with the AnnotationSpec id and display_name, the bounding box, the associated confidence score and the corresponding track_id.

VideoStreamInputConfig

Message describing Video Stream Input Config. This message should only be used as a placeholder for builtin:stream-input processor, actual stream binding should be specified using corresponding API.

Modules

pagers

API documentation for visionai_v1.services.app_platform.pagers module.

pagers

API documentation for visionai_v1.services.live_video_analytics.pagers module.

pagers

API documentation for visionai_v1.services.streams_service.pagers module.

pagers

API documentation for visionai_v1.services.warehouse.pagers module.

pagers

API documentation for visionai_v1alpha1.services.app_platform.pagers module.

pagers

API documentation for visionai_v1alpha1.services.live_video_analytics.pagers module.

pagers

API documentation for visionai_v1alpha1.services.streams_service.pagers module.

pagers

API documentation for visionai_v1alpha1.services.warehouse.pagers module.