Class CreateAnnotationRequest.Builder (0.12.0)

public static final class CreateAnnotationRequest.Builder extends GeneratedMessageV3.Builder<CreateAnnotationRequest.Builder> implements CreateAnnotationRequestOrBuilder

Request message for CreateAnnotation.

Protobuf type google.cloud.visionai.v1.CreateAnnotationRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateAnnotationRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

build()

public CreateAnnotationRequest build()
Returns
Type Description
CreateAnnotationRequest

buildPartial()

public CreateAnnotationRequest buildPartial()
Returns
Type Description
CreateAnnotationRequest

clear()

public CreateAnnotationRequest.Builder clear()
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

clearAnnotation()

public CreateAnnotationRequest.Builder clearAnnotation()

Required. The annotation to create.

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

Returns
Type Description
CreateAnnotationRequest.Builder

clearAnnotationId()

public CreateAnnotationRequest.Builder clearAnnotationId()

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
CreateAnnotationRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateAnnotationRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateAnnotationRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

clearParent()

public CreateAnnotationRequest.Builder clearParent()

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
CreateAnnotationRequest.Builder

This builder for chaining.

clone()

public CreateAnnotationRequest.Builder clone()
Returns
Type Description
CreateAnnotationRequest.Builder
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.

getAnnotationBuilder()

public Annotation.Builder getAnnotationBuilder()

Required. The annotation to create.

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

Returns
Type Description
Annotation.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAnnotation(Annotation value)

public CreateAnnotationRequest.Builder mergeAnnotation(Annotation value)

Required. The annotation to create.

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

Parameter
Name Description
value Annotation
Returns
Type Description
CreateAnnotationRequest.Builder

mergeFrom(CreateAnnotationRequest other)

public CreateAnnotationRequest.Builder mergeFrom(CreateAnnotationRequest other)
Parameter
Name Description
other CreateAnnotationRequest
Returns
Type Description
CreateAnnotationRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateAnnotationRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateAnnotationRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateAnnotationRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

setAnnotation(Annotation value)

public CreateAnnotationRequest.Builder setAnnotation(Annotation value)

Required. The annotation to create.

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

Parameter
Name Description
value Annotation
Returns
Type Description
CreateAnnotationRequest.Builder

setAnnotation(Annotation.Builder builderForValue)

public CreateAnnotationRequest.Builder setAnnotation(Annotation.Builder builderForValue)

Required. The annotation to create.

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

Parameter
Name Description
builderForValue Annotation.Builder
Returns
Type Description
CreateAnnotationRequest.Builder

setAnnotationId(String value)

public CreateAnnotationRequest.Builder setAnnotationId(String value)

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];

Parameter
Name Description
value String

The annotationId to set.

Returns
Type Description
CreateAnnotationRequest.Builder

This builder for chaining.

setAnnotationIdBytes(ByteString value)

public CreateAnnotationRequest.Builder setAnnotationIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for annotationId to set.

Returns
Type Description
CreateAnnotationRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateAnnotationRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

setParent(String value)

public CreateAnnotationRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateAnnotationRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateAnnotationRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateAnnotationRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateAnnotationRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateAnnotationRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateAnnotationRequest.Builder
Overrides