Class: Google::Cloud::DiscoveryEngine::V1::ListDocumentsRequest

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::ListDocumentsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/document_service.rb

Overview

Request message for DocumentService.ListDocuments method.

Instance Attribute Summary

• #page_size ⇒ ::Integer

  Maximum number of Documents to return.

• #page_token ⇒ ::String

  A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#page_size ⇒ ::Integer

Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

Returns:

• (::Integer) —

  Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

  If this field is negative, an INVALID_ARGUMENT error is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 77

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

• (::String) —

  A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 77

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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 Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Returns:

• (::String) —

  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 Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 77

class ListDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end