SchemaService

google.pubsub.v1. SchemaService

Represents a SchemaService

Constructor

new SchemaService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new SchemaService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {SchemaService}

Creates new SchemaService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
SchemaService

RPC service. Useful where requests and/or responses are streamed.

createSchema(request, callback) → {undefined}

Calls CreateSchema.

Parameters:
Name Type Description
request google.pubsub.v1.ICreateSchemaRequest

CreateSchemaRequest message or plain object

callback google.pubsub.v1.SchemaService.CreateSchemaCallback

Node-style callback called with the error, if any, and Schema

Returns:
Type Description
undefined

createSchema(request) → {Promise.<google.pubsub.v1.Schema>}

Calls CreateSchema.

Parameters:
Name Type Description
request google.pubsub.v1.ICreateSchemaRequest

CreateSchemaRequest message or plain object

Returns:
Type Description
Promise.<google.pubsub.v1.Schema>

Promise

deleteSchema(request, callback) → {undefined}

Calls DeleteSchema.

Parameters:
Name Type Description
request google.pubsub.v1.IDeleteSchemaRequest

DeleteSchemaRequest message or plain object

callback google.pubsub.v1.SchemaService.DeleteSchemaCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteSchema(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteSchema.

Parameters:
Name Type Description
request google.pubsub.v1.IDeleteSchemaRequest

DeleteSchemaRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getSchema(request, callback) → {undefined}

Calls GetSchema.

Parameters:
Name Type Description
request google.pubsub.v1.IGetSchemaRequest

GetSchemaRequest message or plain object

callback google.pubsub.v1.SchemaService.GetSchemaCallback

Node-style callback called with the error, if any, and Schema

Returns:
Type Description
undefined

getSchema(request) → {Promise.<google.pubsub.v1.Schema>}

Calls GetSchema.

Parameters:
Name Type Description
request google.pubsub.v1.IGetSchemaRequest

GetSchemaRequest message or plain object

Returns:
Type Description
Promise.<google.pubsub.v1.Schema>

Promise

listSchemas(request, callback) → {undefined}

Calls ListSchemas.

Parameters:
Name Type Description
request google.pubsub.v1.IListSchemasRequest

ListSchemasRequest message or plain object

callback google.pubsub.v1.SchemaService.ListSchemasCallback

Node-style callback called with the error, if any, and ListSchemasResponse

Returns:
Type Description
undefined

listSchemas(request) → {Promise.<google.pubsub.v1.ListSchemasResponse>}

Calls ListSchemas.

Parameters:
Name Type Description
request google.pubsub.v1.IListSchemasRequest

ListSchemasRequest message or plain object

Returns:
Type Description
Promise.<google.pubsub.v1.ListSchemasResponse>

Promise

validateMessage(request, callback) → {undefined}

Calls ValidateMessage.

Parameters:
Name Type Description
request google.pubsub.v1.IValidateMessageRequest

ValidateMessageRequest message or plain object

callback google.pubsub.v1.SchemaService.ValidateMessageCallback

Node-style callback called with the error, if any, and ValidateMessageResponse

Returns:
Type Description
undefined

validateMessage(request) → {Promise.<google.pubsub.v1.ValidateMessageResponse>}

Calls ValidateMessage.

Parameters:
Name Type Description
request google.pubsub.v1.IValidateMessageRequest

ValidateMessageRequest message or plain object

Returns:
Type Description
Promise.<google.pubsub.v1.ValidateMessageResponse>

Promise

validateSchema(request, callback) → {undefined}

Calls ValidateSchema.

Parameters:
Name Type Description
request google.pubsub.v1.IValidateSchemaRequest

ValidateSchemaRequest message or plain object

callback google.pubsub.v1.SchemaService.ValidateSchemaCallback

Node-style callback called with the error, if any, and ValidateSchemaResponse

Returns:
Type Description
undefined

validateSchema(request) → {Promise.<google.pubsub.v1.ValidateSchemaResponse>}

Calls ValidateSchema.

Parameters:
Name Type Description
request google.pubsub.v1.IValidateSchemaRequest

ValidateSchemaRequest message or plain object

Returns:
Type Description
Promise.<google.pubsub.v1.ValidateSchemaResponse>

Promise

Type Definitions

CreateSchemaCallback(error, responseopt)

Callback as used by google.pubsub.v1.SchemaService#createSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.pubsub.v1.Schema <optional>

Schema

DeleteSchemaCallback(error, responseopt)

Callback as used by google.pubsub.v1.SchemaService#deleteSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetSchemaCallback(error, responseopt)

Callback as used by google.pubsub.v1.SchemaService#getSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.pubsub.v1.Schema <optional>

Schema

ListSchemasCallback(error, responseopt)

Callback as used by google.pubsub.v1.SchemaService#listSchemas.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.pubsub.v1.ListSchemasResponse <optional>

ListSchemasResponse

ValidateMessageCallback(error, responseopt)

Callback as used by google.pubsub.v1.SchemaService#validateMessage.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.pubsub.v1.ValidateMessageResponse <optional>

ValidateMessageResponse

ValidateSchemaCallback(error, responseopt)

Callback as used by google.pubsub.v1.SchemaService#validateSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.pubsub.v1.ValidateSchemaResponse <optional>

ValidateSchemaResponse