Package types (0.1.0)

Message describing AI-enabled Devices Input Config.

Represents a hardware accelerator type.

Request message for acquiring a lease.

Message for adding stream input to an Application.

Message for AddApplicationStreamInput Response.

Request message for AddCollectionItem.

Response message for AddCollectionItem.

Message describing the Analysis object.

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

Metadata for AnalyzeAsset.

Request message for AnalyzeAsset.

Response message for AnalyzeAsset.

The metadata message for AnalyzeCorpus LRO.

Request message for AnalyzeCorpus.

The response message for AnalyzeCorpus LRO.

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.

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

Customized struct represnation in annotation.

List representation in annotation.

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

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

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.

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

Message of content of appPlatform event

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.

Message describing Application object

Message storing the graph of the application.

Message for creating a Instance.

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

Message about a single stream input config.

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.

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

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

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

Request message for running the processes in a batch.

Response message for running the processes in a batch.

Message of configurations for BigQuery processor.

Message describing the Channel object.

Representation of a circle area.

Prediction output format for Image and Text Classification.

Request message for ClipAsset API.

Response message for ClipAsset API.

Message describing the Cluster object.

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

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

The message for explicitly committing the read progress.

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

The options for receiver under the controlled mode.

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

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.

Message for creating an Analysis.

Request message for CreateAnnotation.

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

Message for adding stream input to an Application.

Message for CreateApplicationInstance Response.

Message for creating a Application.

Request message for CreateAssetRequest.

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

Message for creating a Cluster.

Metadata message for CreateCollectionRequest

Request message for CreateCollection.

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

Metadata for CreateCorpus API.

Request message of CreateCorpus API.

Request message for CreateDataSchema.

Message for creating a Draft.

Message for creating a Event.

Metadata message for CreateIndexEndpoint.

Request message for CreateIndexEndpoint.

Metadata message for CreateIndexRequest

Message for creating an Index.

Message for creating a Operator.

Message for creating a Process.

Message for creating a Processor.

Request message for CreateSearchConfig.

Request message for creating SearchHypernym.

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

Message for creating a Series.

Message for creating a Stream.

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

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

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

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

All supported data types.

Datetime range type.

A list of datetime range values.

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

Message for deleting an Analysis.

Request message for DeleteAnnotation API.

Message for removing stream input from an Application.

Message for DeleteApplicationInstance Response.

Message for deleting an Application.

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

Request message for DeleteAsset.

Message for deleting a Cluster.

Metadata message for DeleteCollectionRequest

Request message for DeleteCollectionRequest.

Request message for DeleteCorpus.

Request message for DeleteDataSchema.

Message for deleting a Draft.

Message for deleting a Event.

Metadata message for DeleteIndexEndpoint.

Request message for DeleteIndexEndpoint.

Metadata message for DeleteIndexRequest

Request message for DeleteIndex.

Message for deleting a Operator

Message for deleting a Process.

Message for deleting a Processor.

Request message for DeleteSearchConfig.

Request message for deleting SearchHypernym.

Message for deleting a Series.

Message for deleting a Stream.

Message for deploying an Application.

RPC Request Messages. Message for DeployApplication Response.

Metadata message for DeployIndex.

Request message for DeployIndex.

DeployIndex response once the operation is done.

A deployment of an Index.

Points to a DeployedIndex.

Message describing Draft object

The options for receiver under the eager mode.

Message describing the Event object.

The event update message.

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

Different types for a facet bucket.

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

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

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

Float range type.

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

A list of float range values.

Message describing GcsOutputConfig.

The Google Cloud Storage location for the input content.

Message of configurations for General Object Detection processor.

Request message for GenerateHlsUri API.

Response message for GenerateHlsUri API.

Request message for GenerateRetrievalUrl API.

Response message for GenerateRetrievalUrl API.

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

Response message for GenerateStreamHlsToken.

Location Coordinate Representation

A list of locations.

Message for getting an Analysis.

Request message for GetAnnotation API.

Message for getting a Application.

Request message for GetAsset.

Message for getting a Cluster.

Request message for GetCollectionRequest.

Request message for GetCorpus.

Request message for GetDataSchema.

Message for getting a Draft.

Message for getting a Event.

Request message for GetIndexEndpoint.

Request message for getting an Index.

Message for getting a Instance.

Message for getting a Operator.

Message for getting a Process.

Message for getting a Processor.

Request message for GetSearchConfig.

Request message for getting SearchHypernym.

Message for getting a Series.

Message for getting a Stream.

Message for getting the thumbnail of a Stream.

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

The descriptor for a gstreamer buffer payload.

HealthCheckRequest is the request message for Check.

HealthCheckResponse is the response message for Check.

Prediction output format for Image Object Detection.

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

Prediction output format for Image Segmentation.

The metadata message for ImportAssets LRO.

The request message for ImportAssets.

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

The response message for ImportAssets LRO.

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

Metadata for IndexAsset.

Request message for IndexAsset.

Response message for IndexAsset.

Message representing IndexEndpoint resource. Indexes are deployed into it.

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

The status of indexing for the asset.

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

Response message for IngestAsset API.

Message describing Instance object Next ID: 12

Integer range type.

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

A list of integer range values.

The lease message.

The lease type.

Message for requesting list of Analyses

Message for response to listing Analyses

Request message for GetAnnotation API.

Request message for ListAnnotations API.

Message for requesting list of Applications.

Message for response to listing Applications.

Request message for ListAssets.

Response message for ListAssets.

Message for requesting list of Clusters.

Message for response to listing Clusters.

Request message for ListCollections.

Response message for ListCollections.

Request message for ListCorpora.

Response message for ListCorpora.

Request message for ListDataSchemas.

Response message for ListDataSchemas.

Message for requesting list of Drafts.

Message for response to listing Drafts.

Message for requesting list of Events.

Message for response to listing Events.

Request message for ListIndexEndpoints.

Response message for ListIndexEndpoints.

Request message for listing Indexes.

Response message for ListIndexes.

Message for requesting list of Instances.

Message for response to listing Instances.

Message for requesting list of Operators.

Message for response to listing Operators.

Request Message for listing Prebuilt Processors.

Response Message for listing Prebuilt Processors.

Message for requesting list of Processes.

Message for response to listing Processes.

Message for requesting list of Processors.

Message for response to listing Processors.

Request message of ListPublicOperatorsRequest API.

Response message of ListPublicOperators API.

Request message for ListSearchConfigs.

Response message for ListSearchConfigs.

Request message for listing SearchHypernyms.

Response message for listing SearchHypernyms.

Message for requesting list of Series.

Message for response to listing Series.

Message for requesting list of Streams.

Message for response to listing Streams.

Specification of a single machine.

Message for materializing a channel.

Message describing MediaWarehouseConfig.

All the supported model types in Vision AI App Platform.

Message describing node object.

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

Normalized Polygon.

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

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.

Prediction output format for Generic Object Detection.

Message describing OccupancyCountConfig.

The prediction result proto for occupancy counting.

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

Represents the metadata of the long-running operation.

Message describing the Operator object.

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.

OperatorQuery represents one query to a Operator.

The quanta of datum that the series accepts.

The message that represents packet header.

The message that represents the data type of a packet.

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

Message describing FaceBlurConfig.

Message describing PersonVehicleDetectionConfig.

Message describing PersonalProtectiveEquipmentDetectionConfig.

Output format for Personal Protective Equipment Detection Operator.

Message describing the Process object.

Message describing Processor object. Next ID: 19

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

Message describing the input / output specifications of a processor.

Message describing ProductRecognizerConfig.

The descriptor for a raw image.

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

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

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

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

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

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

The enum of the types of the Registry.

Request message for releasing lease.

Response message for release lease.

Message for removing stream input from an Application.

Message for RemoveApplicationStreamInput Response.

Request message for RemoveCollectionItem.

Request message for RemoveCollectionItem.

Metadata for RemoveIndexAsset.

Request message for RemoveIndexAsset.

Response message for RemoveIndexAsset.

Request message for renewing a lease.

RequestMetadata is the metadata message for the request.

Request message for querying operator info.

Response message of ResolveOperatorInfo API.

Message describing general annotation for resources.

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 represents the mode to launch the Process on.

Message describing the status of the Process.

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

Request message for SearchAssets.

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

Response message for SearchAssets.

The capability and metadata of search capability.

Setting for search capability to enable.

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

Central configuration for custom search criteria.

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.

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

Response message for SearchIndexEndpoint.

Search result contains asset name and corresponding time ranges.

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

Response message for sending packets.

Message describing the Series object.

The message that represents series metadata.

The message that represents server metadata.

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.

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

Enum describing all possible types of a stream annotation.

A wrapper of repeated StreamAnnotation.

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

A list of string-type values.

Configuration for tag parsing.

Message describing TagRecognizerConfig.

Message for undeploying an Application.

Message for UndeployApplication Response.

Metadata message for UndeployIndex.

Request message for UndeployIndexEndpoint.

UndeployIndex response once the operation is done.

Message describing UniversalInputConfig.

Message for updating an Analysis.

Request message for UpdateAnnotation API.

Message for updating an ApplicationInstance.

Message for UpdateApplicationInstances Response.

Message for updating an Application.

Message for updating stream input to an Application.

Message for AddApplicationStreamInput Response.

Request message for UpdateAsset.

Message for updating a Cluster.

Request message for UpdateCollectionRequest.

Request message for UpdateCorpus.

Request message for UpdateDataSchema.

Message for updating a Draft.

Message for updating a Event.

Metadata message for UpdateIndexEndpoint.

Request message for UpdateIndexEndpoint.

Metadata message for UpdateIndexRequest

Request message for UpdateIndex.

Message for updating a Operator.

Message for updating a Process.

Message for updating a Processor.

Request message for UpdateSearchConfig.

Request message for updating SearchHypernym.

Message for updating a Series.

Message for updating a Stream.

Metadata for UploadAsset.

Request message for UploadAsset.

Response message for UploadAsset.

Annotation provided by users.

Message describing VertexAutoMLVideoConfig.

Message of configurations of Vertex AutoML Vision Processors.

Message describing VertexCustomConfig.

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

Prediction output format for Video Action Recognition.

Prediction output format for Video Classification.

Prediction output format for Video Object Tracking.

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.

Request message for ViewCollectionItems.

Response message for ViewCollectionItems.

Request message for ViewIndexedAssets.

Response message for ViewIndexedAssets.