Class ListAnnotationsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListAnnotationsRequest.Builder>
com.google.cloud.visionai.v1.ListAnnotationsRequest.Builder
All Implemented Interfaces:
ListAnnotationsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListAnnotationsRequest

public static final class ListAnnotationsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListAnnotationsRequest.Builder> implements ListAnnotationsRequestOrBuilder
 Request message for GetAnnotation API.
 
Protobuf type google.cloud.visionai.v1.ListAnnotationsRequest
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListAnnotationsRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListAnnotationsRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListAnnotationsRequest.Builder>
    • getDefaultInstanceForType

      public ListAnnotationsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ListAnnotationsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ListAnnotationsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public ListAnnotationsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListAnnotationsRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListAnnotationsRequest.Builder>
    • mergeFrom

      public ListAnnotationsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListAnnotationsRequest.Builder>
      Throws:
      IOException
    • 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) = { ... }
      Specified by:
      getParent in interface ListAnnotationsRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getParentBytes in interface ListAnnotationsRequestOrBuilder
      Returns:
      The bytes for parent.
    • setParent

      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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      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:
      This builder for chaining.
    • setParentBytes

      public ListAnnotationsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.
    • 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;
      Specified by:
      getPageSize in interface ListAnnotationsRequestOrBuilder
      Returns:
      The pageSize.
    • setPageSize

      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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • 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;
      Specified by:
      getPageToken in interface ListAnnotationsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.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;
      Specified by:
      getPageTokenBytes in interface ListAnnotationsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • setPageToken

      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;
      Parameters:
      value - The pageToken to set.
      Returns:
      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:
      This builder for chaining.
    • setPageTokenBytes

      public ListAnnotationsRequest.Builder setPageTokenBytes(com.google.protobuf.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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.
    • 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;
      Specified by:
      getFilter in interface ListAnnotationsRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public com.google.protobuf.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;
      Specified by:
      getFilterBytes in interface ListAnnotationsRequestOrBuilder
      Returns:
      The bytes for filter.
    • setFilter

      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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • setFilterBytes

      public ListAnnotationsRequest.Builder setFilterBytes(com.google.protobuf.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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.