Package com.google.cloud.visionai.v1

Interface ViewIndexedAssetsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ViewIndexedAssetsRequest, ViewIndexedAssetsRequest.Builder
@Generated public interface ViewIndexedAssetsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    The filter applied to the returned list.
    com.google.protobuf.ByteString
    getFilterBytes()
    The filter applied to the returned list.
    String
    getIndex()
    Required.
    com.google.protobuf.ByteString
    getIndexBytes()
    Required.
    int
    getPageSize()
    The maximum number of assets to return.
    String
    getPageToken()
    A page token, received from a previous `ViewIndexedAssets` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ViewIndexedAssets` call.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getIndex

      String getIndex()
       Required. The index that owns this collection of assets.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}`
      string index = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The index.

    • getIndexBytes

      com.google.protobuf.ByteString getIndexBytes()
       Required. The index that owns this collection of assets.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}`
      string index = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for index.

    • getPageSize

      int getPageSize()
       The maximum number of assets to return. The service may return fewer than
 this value.
 If unspecified, at most 50 assets will be returned.
 The maximum value is 1000; values above 1000 will be coerced to 1000.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token, received from a previous `ViewIndexedAssets` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ViewIndexedAssets` must
 match the call that provided the page token.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ViewIndexedAssets` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ViewIndexedAssets` must
 match the call that provided the page token.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       The filter applied to the returned list.
 Only the following filterings are supported:
 "asset_id = xxxx", which returns asset with specified id.
 "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.
      string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       The filter applied to the returned list.
 Only the following filterings are supported:
 "asset_id = xxxx", which returns asset with specified id.
 "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.
      string filter = 4;
      Returns:
      The bytes for filter.