Package com.google.cloud.discoveryengine.v1beta

Interface ListDocumentsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s to return.
    String
    getPageToken()
    A page token [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token], received from a previous [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token], received from a previous [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    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

    • getParent

      String getParent()
       Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1beta.Document]s under this
 branch, regardless of whether or not this branch exists, a
 `PERMISSION_DENIED` error is returned.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1beta.Document]s under this
 branch, regardless of whether or not this branch exists, a
 `PERMISSION_DENIED` error is returned.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
 to return. If unspecified, defaults to 100. The maximum allowed value is
 1000. Values above 1000 are set to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Returns:
      The bytes for pageToken.