Google Cloud Vision Ai V1 Client - Class CreateAnnotationRequest (0.3.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class CreateAnnotationRequest.

Request message for CreateAnnotation.

Generated from protobuf message google.cloud.visionai.v1.CreateAnnotationRequest

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent resource where this annotation will be created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

↳ annotation
Annotation

Required. The annotation to create.

↳ annotation_id
string

Optional. The ID to use for the annotation, which will become the final component of the annotation's resource name if user choose to specify. Otherwise, annotation id will be generated by system. This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

getParent

Required. The parent resource where this annotation will be created.

Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

Returns
Type
Description
string

setParent

Required. The parent resource where this annotation will be created.

Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAnnotation

Required. The annotation to create.

Returns
Type
Description
Annotation |null

hasAnnotation

clearAnnotation

setAnnotation

Required. The annotation to create.

Parameter
Name
Description
Returns
Type
Description
$this

getAnnotationId

Optional. The ID to use for the annotation, which will become the final component of the annotation's resource name if user choose to specify.

Otherwise, annotation id will be generated by system. This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

Returns
Type
Description
string

hasAnnotationId

clearAnnotationId

setAnnotationId

Optional. The ID to use for the annotation, which will become the final component of the annotation's resource name if user choose to specify.

Otherwise, annotation id will be generated by system. This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameters
Name
Description
parent
string

Required. The parent resource where this annotation will be created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id} Please see WarehouseClient::assetName() for help formatting this field.

annotation
Annotation

Required. The annotation to create.

annotationId
string

Optional. The ID to use for the annotation, which will become the final component of the annotation's resource name if user choose to specify. Otherwise, annotation id will be generated by system.

This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: