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

commitSchema(request, callback) → {undefined}

Calls CommitSchema.

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

CommitSchemaRequest message or plain object
callback google.pubsub.v1.SchemaService.CommitSchemaCallback

Node-style callback called with the error, if any, and Schema
Returns:
Type Description
undefined

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

Calls CommitSchema.

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

CommitSchemaRequest message or plain object
Returns:
Type Description
Promise.<google.pubsub.v1.Schema>

Promise

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

deleteSchemaRevision(request, callback) → {undefined}

Calls DeleteSchemaRevision.

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

DeleteSchemaRevisionRequest message or plain object
callback google.pubsub.v1.SchemaService.DeleteSchemaRevisionCallback

Node-style callback called with the error, if any, and Schema
Returns:
Type Description
undefined

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

Calls DeleteSchemaRevision.

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

DeleteSchemaRevisionRequest message or plain object
Returns:
Type Description
Promise.<google.pubsub.v1.Schema>

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

listSchemaRevisions(request, callback) → {undefined}

Calls ListSchemaRevisions.

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

ListSchemaRevisionsRequest message or plain object
callback google.pubsub.v1.SchemaService.ListSchemaRevisionsCallback

Node-style callback called with the error, if any, and ListSchemaRevisionsResponse
Returns:
Type Description
undefined

listSchemaRevisions(request) → {Promise.<google.pubsub.v1.ListSchemaRevisionsResponse>}

Calls ListSchemaRevisions.

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

ListSchemaRevisionsRequest message or plain object
Returns:
Type Description
Promise.<google.pubsub.v1.ListSchemaRevisionsResponse>

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

rollbackSchema(request, callback) → {undefined}

Calls RollbackSchema.

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

RollbackSchemaRequest message or plain object
callback google.pubsub.v1.SchemaService.RollbackSchemaCallback

Node-style callback called with the error, if any, and Schema
Returns:
Type Description
undefined

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

Calls RollbackSchema.

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

RollbackSchemaRequest message or plain object
Returns:
Type Description
Promise.<google.pubsub.v1.Schema>

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

(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.

Type Definitions

CommitSchemaCallback(error, responseopt)

Callback as used by commitSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.Schema <optional>

Schema

CreateSchemaCallback(error, responseopt)

Callback as used by 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 deleteSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

DeleteSchemaRevisionCallback(error, responseopt)

Callback as used by deleteSchemaRevision.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.Schema <optional>

Schema

GetSchemaCallback(error, responseopt)

Callback as used by getSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.Schema <optional>

Schema

ListSchemaRevisionsCallback(error, responseopt)

Callback as used by listSchemaRevisions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.ListSchemaRevisionsResponse <optional>

ListSchemaRevisionsResponse

ListSchemasCallback(error, responseopt)

Callback as used by listSchemas.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.ListSchemasResponse <optional>

ListSchemasResponse

RollbackSchemaCallback(error, responseopt)

Callback as used by rollbackSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.Schema <optional>

Schema

ValidateMessageCallback(error, responseopt)

Callback as used by 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 validateSchema.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.pubsub.v1.ValidateSchemaResponse <optional>

ValidateSchemaResponse