Interface CreateAnnotationRequestOrBuilder (0.12.0)

public interface CreateAnnotationRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotation()

public abstract Annotation getAnnotation()

Required. The annotation to create.

.google.cloud.visionai.v1.Annotation annotation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Annotation

The annotation.

getAnnotationId()

public abstract String 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-/. The first character must be a letter, the last could be a letter or a number.

optional string annotation_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The annotationId.

getAnnotationIdBytes()

public abstract ByteString getAnnotationIdBytes()

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-/. The first character must be a letter, the last could be a letter or a number.

optional string annotation_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for annotationId.

getAnnotationOrBuilder()

public abstract AnnotationOrBuilder getAnnotationOrBuilder()

Required. The annotation to create.

.google.cloud.visionai.v1.Annotation annotation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AnnotationOrBuilder

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasAnnotation()

public abstract boolean hasAnnotation()

Required. The annotation to create.

.google.cloud.visionai.v1.Annotation annotation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the annotation field is set.

hasAnnotationId()

public abstract boolean hasAnnotationId()

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-/. The first character must be a letter, the last could be a letter or a number.

optional string annotation_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the annotationId field is set.