- Resource: Annotation
- UserSpecifiedAnnotation
- AnnotationValue
- GeoCoordinate
- AnnotationList
- AnnotationCustomizedStruct
- Partition
- TemporalPartition
- SpatialPartition
- RelativeTemporalPartition
- Methods
Resource: Annotation
An annotation is a resource in asset. It represents a key-value mapping of content in asset.
JSON representation |
---|
{
"name": string,
"userSpecifiedAnnotation": {
object ( |
Fields | |
---|---|
name |
Resource name of the annotation. Format: |
userSpecifiedAnnotation |
User provided annotation. |
UserSpecifiedAnnotation
Annotation provided by users.
JSON representation |
---|
{ "key": string, "value": { object ( |
Fields | |
---|---|
key |
Required. Key of the annotation. The key must be set with type by CreateDataSchema. |
value |
Value of the annotation. The value must be able to convert to the type according to the data schema. |
partition |
Partition information in time and space for the sub-asset level annotation. |
AnnotationValue
Value of annotation, including all types available in data schema.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
intValue |
Value of int type annotation. |
floatValue |
Value of float type annotation. |
strValue |
Value of string type annotation. |
datetimeValue |
Value of date time type annotation. |
geoCoordinate |
Value of geo coordinate type annotation. |
protoAnyValue |
Value of any proto value. An object containing fields of an arbitrary type. An additional field |
boolValue |
Value of boolean type annotation. |
customizedStructDataValue |
Value of customized struct annotation. This field does not have effects. Use customizedStructValue instead for customized struct annotation. |
listValue |
Value of list type annotation. |
customizedStructValue |
Value of custom struct type annotation. |
GeoCoordinate
Location Coordinate Representation
JSON representation |
---|
{ "latitude": number, "longitude": number } |
Fields | |
---|---|
latitude |
Latitude Coordinate. Degrees [-90 .. 90] |
longitude |
Longitude Coordinate. Degrees [-180 .. 180] |
AnnotationList
List representation in annotation.
JSON representation |
---|
{
"values": [
{
object ( |
Fields | |
---|---|
values[] |
The values of |
AnnotationCustomizedStruct
Customized struct represnation in annotation.
JSON representation |
---|
{
"elements": {
string: {
object ( |
Fields | |
---|---|
elements |
A map from elements' keys to element's annotation value. An object containing a list of |
Partition
Partition to specify the partition in time and space for sub-asset level annotation.
JSON representation |
---|
{ "temporalPartition": { object ( |
Fields | |
---|---|
temporalPartition |
Partition of asset in time. |
spatialPartition |
Partition of asset in space. |
relativeTemporalPartition |
Partition of asset in time. |
TemporalPartition
Partition of asset in UTC Epoch time. Supported by STREAM_VIDEO corpus type.
JSON representation |
---|
{ "startTime": string, "endTime": string } |
Fields | |
---|---|
startTime |
Start time of the partition. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
End time of the partition. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
SpatialPartition
Partition of asset in space.
JSON representation |
---|
{ "xMin": string, "yMin": string, "xMax": string, "yMax": string } |
Fields | |
---|---|
xMin |
The minimum x coordinate value. |
yMin |
The minimum y coordinate value. |
xMax |
The maximum x coordinate value. |
yMax |
The maximum y coordinate value. |
RelativeTemporalPartition
Partition of asset in relative time. Supported by VIDEO_ON_DEMAND corpus type.
JSON representation |
---|
{ "startOffset": string, "endOffset": string } |
Fields | |
---|---|
startOffset |
Start time offset of the partition. A duration in seconds with up to nine fractional digits, ending with ' |
endOffset |
End time offset of the partition. A duration in seconds with up to nine fractional digits, ending with ' |
Methods |
|
---|---|
|
Creates annotation inside asset. |
|
Deletes annotation inside asset. |
|
Reads annotation inside asset. |
|
Lists a list of annotations inside asset. |
|
Updates annotation inside asset. |