com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores.Branches

public class DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents
extends Object

The "documents" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Create
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.DiscoveryEngineImport
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Get
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.List
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Patch
class	DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Purge

Constructor Summary

Constructors

Constructor and Description
Documents()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Create	create(String parent, GoogleCloudDiscoveryengineV1Document content) Creates a Document.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	delete(String name) Deletes a Document.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.DiscoveryEngineImport	discoveryengineImport(String parent, GoogleCloudDiscoveryengineV1ImportDocumentsRequest content) Bulk import of multiple Documents.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Get	get(String name) Gets a Document.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.List	list(String parent) Gets a list of Documents.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Patch	patch(String name, GoogleCloudDiscoveryengineV1Document content) Updates a Document.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Purge	purge(String parent, GoogleCloudDiscoveryengineV1PurgeDocumentsRequest content) Permanently deletes all selected Documents in a branch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Documents

public Documents()

Method Detail

create

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Create create(String parent,
                                                                                      GoogleCloudDiscoveryengineV1Document content)
                                                                               throws IOException

Creates a Document. Create a request for the method "documents.create". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{co llection}/dataStores/{data_store}/branches/{branch}`.

content - the GoogleCloudDiscoveryengineV1Document

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete delete(String name)
                                                                               throws IOException

Deletes a Document. Create a request for the method "documents.delete". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collectio ns/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Get get(String name)
                                                                         throws IOException

Gets a Document. Create a request for the method "documents.get". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collectio ns/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.

Returns:

the request

Throws:

IOException

discoveryengineImport

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.DiscoveryEngineImport discoveryengineImport(String parent,
                                                                                                                    GoogleCloudDiscoveryengineV1ImportDocumentsRequest content)
                                                                                                             throws IOException

Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. Create a request for the method "documents.import". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collecti ons/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.

content - the GoogleCloudDiscoveryengineV1ImportDocumentsRequest

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.List list(String parent)
                                                                           throws IOException

Gets a list of Documents. Create a request for the method "documents.list". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collecti ons/{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:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Patch patch(String name,
                                                                                    GoogleCloudDiscoveryengineV1Document content)
                                                                             throws IOException

Updates a Document. Create a request for the method "documents.patch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/ collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id} `. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

content - the GoogleCloudDiscoveryengineV1Document

Returns:

the request

Throws:

IOException

purge

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Purge purge(String parent,
                                                                                    GoogleCloudDiscoveryengineV1PurgeDocumentsRequest content)
                                                                             throws IOException

Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. Create a request for the method "documents.purge". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{co llection}/dataStores/{data_store}/branches/{branch}`.

content - the GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

Returns:

the request

Throws:

IOException