Class DocumentServiceGrpc.DocumentServiceBlockingStub (0.48.0)

public static final class DocumentServiceGrpc.DocumentServiceBlockingStub extends AbstractBlockingStub<DocumentServiceGrpc.DocumentServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DocumentService.

Service for ingesting Document information of the customer's website.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DocumentServiceGrpc.DocumentServiceBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)

public BatchGetDocumentsMetadataResponse batchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest request)

Gets index freshness metadata for Documents. Supported for website search only.

Parameter
Name	Description
`request`	`BatchGetDocumentsMetadataRequest`

Returns
Type	Description
`BatchGetDocumentsMetadataResponse`

build(Channel channel, CallOptions callOptions)

protected DocumentServiceGrpc.DocumentServiceBlockingStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`DocumentServiceGrpc.DocumentServiceBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocument(CreateDocumentRequest request)

public Document createDocument(CreateDocumentRequest request)

Creates a Document.

Parameter
Name	Description
`request`	`CreateDocumentRequest`

Returns
Type	Description
`Document`

deleteDocument(DeleteDocumentRequest request)

public Empty deleteDocument(DeleteDocumentRequest request)

Deletes a Document.

Parameter
Name	Description
`request`	`DeleteDocumentRequest`

Returns
Type	Description
`Empty`

getDocument(GetDocumentRequest request)

public Document getDocument(GetDocumentRequest request)

Gets a Document.

Parameter
Name	Description
`request`	`GetDocumentRequest`

Returns
Type	Description
`Document`

getProcessedDocument(GetProcessedDocumentRequest request)

public ProcessedDocument getProcessedDocument(GetProcessedDocumentRequest request)

Gets the parsed layout information for a Document.

Parameter
Name	Description
`request`	`GetProcessedDocumentRequest`

Returns
Type	Description
`ProcessedDocument`

importDocuments(ImportDocumentsRequest request)

public Operation importDocuments(ImportDocumentsRequest request)

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.

Parameter
Name	Description
`request`	`ImportDocumentsRequest`

Returns
Type	Description
`Operation`

listDocuments(ListDocumentsRequest request)

public ListDocumentsResponse listDocuments(ListDocumentsRequest request)

Gets a list of Documents.

Parameter
Name	Description
`request`	`ListDocumentsRequest`

Returns
Type	Description
`ListDocumentsResponse`

purgeDocuments(PurgeDocumentsRequest request)

public Operation purgeDocuments(PurgeDocumentsRequest request)

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.

Parameter
Name	Description
`request`	`PurgeDocumentsRequest`

Returns
Type	Description
`Operation`

updateDocument(UpdateDocumentRequest request)

public Document updateDocument(UpdateDocumentRequest request)

Updates a Document.

Parameter
Name	Description
`request`	`UpdateDocumentRequest`

Returns
Type	Description
`Document`