Class DocumentSchemaServiceGrpc.DocumentSchemaServiceBlockingStub (0.2.0)

public static final class DocumentSchemaServiceGrpc.DocumentSchemaServiceBlockingStub extends AbstractBlockingStub<DocumentSchemaServiceGrpc.DocumentSchemaServiceBlockingStub>

This service lets you manage document schema.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DocumentSchemaServiceGrpc.DocumentSchemaServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

createDocumentSchema(CreateDocumentSchemaRequest request)

public DocumentSchema createDocumentSchema(CreateDocumentSchemaRequest request)

Creates a document schema.

Parameter
NameDescription
requestCreateDocumentSchemaRequest
Returns
TypeDescription
DocumentSchema

deleteDocumentSchema(DeleteDocumentSchemaRequest request)

public 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
Empty

getDocumentSchema(GetDocumentSchemaRequest request)

public DocumentSchema getDocumentSchema(GetDocumentSchemaRequest request)

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

Parameter
NameDescription
requestGetDocumentSchemaRequest
Returns
TypeDescription
DocumentSchema

listDocumentSchemas(ListDocumentSchemasRequest request)

public ListDocumentSchemasResponse listDocumentSchemas(ListDocumentSchemasRequest request)

Lists document schemas.

Parameter
NameDescription
requestListDocumentSchemasRequest
Returns
TypeDescription
ListDocumentSchemasResponse

updateDocumentSchema(UpdateDocumentSchemaRequest request)

public 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
DocumentSchema