Class CreateAnnotationRequest (0.9.0)

public final class CreateAnnotationRequest extends GeneratedMessageV3 implements CreateAnnotationRequestOrBuilder

Request message for CreateAnnotation.

Protobuf type google.cloud.visionai.v1.CreateAnnotationRequest

Static Fields

ANNOTATION_FIELD_NUMBER

public static final int ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_ID_FIELD_NUMBER

public static final int ANNOTATION_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateAnnotationRequest getDefaultInstance()
Returns
Type Description
CreateAnnotationRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateAnnotationRequest.Builder newBuilder()
Returns
Type Description
CreateAnnotationRequest.Builder

newBuilder(CreateAnnotationRequest prototype)

public static CreateAnnotationRequest.Builder newBuilder(CreateAnnotationRequest prototype)
Parameter
Name Description
prototype CreateAnnotationRequest
Returns
Type Description
CreateAnnotationRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateAnnotationRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateAnnotationRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateAnnotationRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateAnnotationRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateAnnotationRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateAnnotationRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateAnnotationRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateAnnotationRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateAnnotationRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateAnnotationRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateAnnotationRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateAnnotationRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateAnnotationRequest> parser()
Returns
Type Description
Parser<CreateAnnotationRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotation()

public 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 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 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 AnnotationOrBuilder getAnnotationOrBuilder()

Required. The annotation to create.

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

Returns
Type Description
AnnotationOrBuilder

getDefaultInstanceForType()

public CreateAnnotationRequest getDefaultInstanceForType()
Returns
Type Description
CreateAnnotationRequest

getParent()

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

getParserForType()

public Parser<CreateAnnotationRequest> getParserForType()
Returns
Type Description
Parser<CreateAnnotationRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAnnotation()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateAnnotationRequest.Builder newBuilderForType()
Returns
Type Description
CreateAnnotationRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateAnnotationRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateAnnotationRequest.Builder toBuilder()
Returns
Type Description
CreateAnnotationRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException