Class DocumentSchemaServiceGrpc.DocumentSchemaServiceFutureStub (0.3.0)

public static final class DocumentSchemaServiceGrpc.DocumentSchemaServiceFutureStub extends AbstractFutureStub<DocumentSchemaServiceGrpc.DocumentSchemaServiceFutureStub>

This service lets you manage document schema.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DocumentSchemaServiceGrpc.DocumentSchemaServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected DocumentSchemaServiceGrpc.DocumentSchemaServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DocumentSchemaServiceGrpc.DocumentSchemaServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDocumentSchema(CreateDocumentSchemaRequest request)

public ListenableFuture<DocumentSchema> createDocumentSchema(CreateDocumentSchemaRequest request)

Creates a document schema.

Parameter
NameDescription
requestCreateDocumentSchemaRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DocumentSchema>

deleteDocumentSchema(DeleteDocumentSchemaRequest request)

public ListenableFuture<Empty> deleteDocumentSchema(DeleteDocumentSchemaRequest request)

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.

Parameter
NameDescription
requestDeleteDocumentSchemaRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getDocumentSchema(GetDocumentSchemaRequest request)

public ListenableFuture<DocumentSchema> getDocumentSchema(GetDocumentSchemaRequest request)

Gets a document schema. Returns NOT_FOUND if the document schema does not exist.

Parameter
NameDescription
requestGetDocumentSchemaRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DocumentSchema>

listDocumentSchemas(ListDocumentSchemasRequest request)

public ListenableFuture<ListDocumentSchemasResponse> listDocumentSchemas(ListDocumentSchemasRequest request)

Lists document schemas.

Parameter
NameDescription
requestListDocumentSchemasRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDocumentSchemasResponse>

updateDocumentSchema(UpdateDocumentSchemaRequest request)

public ListenableFuture<DocumentSchema> updateDocumentSchema(UpdateDocumentSchemaRequest request)

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.

Parameter
NameDescription
requestUpdateDocumentSchemaRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DocumentSchema>