public static final class ListAnnotationsRequest.Builder extends GeneratedMessageV3.Builder<ListAnnotationsRequest.Builder> implements ListAnnotationsRequestOrBuilderRequest message for GetAnnotation API.
Protobuf type google.cloud.visionai.v1.ListAnnotationsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListAnnotationsRequest.BuilderImplements
ListAnnotationsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListAnnotationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
build()
public ListAnnotationsRequest build()| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest |
|
buildPartial()
public ListAnnotationsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest |
|
clear()
public ListAnnotationsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListAnnotationsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
clearFilter()
public ListAnnotationsRequest.Builder clearFilter() The filter applied to the returned list.
We only support filtering for the following fields:
For corpus of STREAM_VIDEO type:
partition.temporal_partition.start_time,
partition.temporal_partition.end_time, and key.
For corpus of VIDEO_ON_DEMAND type,
partition.relative_temporal_partition.start_offset,
partition.relative_temporal_partition.end_offset, and key.
For corpus of IMAGE type, only key is supported.
Timestamps are specified in the RFC-3339 format, and only one restriction
may be applied per field, joined by conjunctions.
Format:
"partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND
partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND
key = "example_key""
string filter = 4;
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListAnnotationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
clearPageSize()
public ListAnnotationsRequest.Builder clearPageSize()The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListAnnotationsRequest.Builder clearPageToken() A page token, received from a previous ListAnnotations call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAnnotations must
match the call that provided the page token.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
clearParent()
public ListAnnotationsRequest.Builder clearParent() The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
string parent = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
clone()
public ListAnnotationsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
getDefaultInstanceForType()
public ListAnnotationsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter() The filter applied to the returned list.
We only support filtering for the following fields:
For corpus of STREAM_VIDEO type:
partition.temporal_partition.start_time,
partition.temporal_partition.end_time, and key.
For corpus of VIDEO_ON_DEMAND type,
partition.relative_temporal_partition.start_offset,
partition.relative_temporal_partition.end_offset, and key.
For corpus of IMAGE type, only key is supported.
Timestamps are specified in the RFC-3339 format, and only one restriction
may be applied per field, joined by conjunctions.
Format:
"partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND
partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND
key = "example_key""
string filter = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes() The filter applied to the returned list.
We only support filtering for the following fields:
For corpus of STREAM_VIDEO type:
partition.temporal_partition.start_time,
partition.temporal_partition.end_time, and key.
For corpus of VIDEO_ON_DEMAND type,
partition.relative_temporal_partition.start_offset,
partition.relative_temporal_partition.end_offset, and key.
For corpus of IMAGE type, only key is supported.
Timestamps are specified in the RFC-3339 format, and only one restriction
may be applied per field, joined by conjunctions.
Format:
"partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND
partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND
key = "example_key""
string filter = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public int getPageSize()The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken() A page token, received from a previous ListAnnotations call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAnnotations must
match the call that provided the page token.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() A page token, received from a previous ListAnnotations call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAnnotations must
match the call that provided the page token.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent() The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
string parent = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes() The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
string parent = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListAnnotationsRequest other)
public ListAnnotationsRequest.Builder mergeFrom(ListAnnotationsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListAnnotationsRequest |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListAnnotationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListAnnotationsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListAnnotationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListAnnotationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
setFilter(String value)
public ListAnnotationsRequest.Builder setFilter(String value) The filter applied to the returned list.
We only support filtering for the following fields:
For corpus of STREAM_VIDEO type:
partition.temporal_partition.start_time,
partition.temporal_partition.end_time, and key.
For corpus of VIDEO_ON_DEMAND type,
partition.relative_temporal_partition.start_offset,
partition.relative_temporal_partition.end_offset, and key.
For corpus of IMAGE type, only key is supported.
Timestamps are specified in the RFC-3339 format, and only one restriction
may be applied per field, joined by conjunctions.
Format:
"partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND
partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND
key = "example_key""
string filter = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListAnnotationsRequest.Builder setFilterBytes(ByteString value) The filter applied to the returned list.
We only support filtering for the following fields:
For corpus of STREAM_VIDEO type:
partition.temporal_partition.start_time,
partition.temporal_partition.end_time, and key.
For corpus of VIDEO_ON_DEMAND type,
partition.relative_temporal_partition.start_offset,
partition.relative_temporal_partition.end_offset, and key.
For corpus of IMAGE type, only key is supported.
Timestamps are specified in the RFC-3339 format, and only one restriction
may be applied per field, joined by conjunctions.
Format:
"partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND
partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND
key = "example_key""
string filter = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListAnnotationsRequest.Builder setPageSize(int value)The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListAnnotationsRequest.Builder setPageToken(String value) A page token, received from a previous ListAnnotations call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAnnotations must
match the call that provided the page token.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListAnnotationsRequest.Builder setPageTokenBytes(ByteString value) A page token, received from a previous ListAnnotations call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAnnotations must
match the call that provided the page token.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListAnnotationsRequest.Builder setParent(String value) The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
string parent = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListAnnotationsRequest.Builder setParentBytes(ByteString value) The parent, which owns this collection of annotations.
Format:
projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}
string parent = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListAnnotationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListAnnotationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListAnnotationsRequest.Builder |
|