Interface DocumentSchemaServiceGrpc.AsyncService (0.37.0)

public static interface DocumentSchemaServiceGrpc.AsyncService

This service lets you manage document schema.

Methods

createDocumentSchema(CreateDocumentSchemaRequest request, StreamObserver<DocumentSchema> responseObserver)

public default void createDocumentSchema(CreateDocumentSchemaRequest request, StreamObserver<DocumentSchema> responseObserver)

Creates a document schema.

Parameters
NameDescription
requestCreateDocumentSchemaRequest
responseObserverio.grpc.stub.StreamObserver<DocumentSchema>

deleteDocumentSchema(DeleteDocumentSchemaRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDocumentSchema(DeleteDocumentSchemaRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestDeleteDocumentSchemaRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getDocumentSchema(GetDocumentSchemaRequest request, StreamObserver<DocumentSchema> responseObserver)

public default void getDocumentSchema(GetDocumentSchemaRequest request, StreamObserver<DocumentSchema> responseObserver)

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

Parameters
NameDescription
requestGetDocumentSchemaRequest
responseObserverio.grpc.stub.StreamObserver<DocumentSchema>

listDocumentSchemas(ListDocumentSchemasRequest request, StreamObserver<ListDocumentSchemasResponse> responseObserver)

public default void listDocumentSchemas(ListDocumentSchemasRequest request, StreamObserver<ListDocumentSchemasResponse> responseObserver)

Lists document schemas.

Parameters
NameDescription
requestListDocumentSchemasRequest
responseObserverio.grpc.stub.StreamObserver<ListDocumentSchemasResponse>

updateDocumentSchema(UpdateDocumentSchemaRequest request, StreamObserver<DocumentSchema> responseObserver)

public default void updateDocumentSchema(UpdateDocumentSchemaRequest request, StreamObserver<DocumentSchema> responseObserver)

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.

Parameters
NameDescription
requestUpdateDocumentSchemaRequest
responseObserverio.grpc.stub.StreamObserver<DocumentSchema>