Class protos.google.pubsub.v1.SchemaService (4.4.0)

Represents a SchemaService

Inheritance

$protobuf.rpc.Service > protos.google.pubsub.v1.SchemaService

Package

@google-cloud/pubsub

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new SchemaService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

commitSchema(request, callback)

public commitSchema(request: google.pubsub.v1.ICommitSchemaRequest, callback: google.pubsub.v1.SchemaService.CommitSchemaCallback): void;

Calls CommitSchema.

Parameters
Name Description
request ICommitSchemaRequest

CommitSchemaRequest message or plain object
callback CommitSchemaCallback

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

commitSchema(request)

public commitSchema(request: google.pubsub.v1.ICommitSchemaRequest): Promise<google.pubsub.v1.Schema>;

Calls CommitSchema.

Parameter
Name Description
request ICommitSchemaRequest

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

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): SchemaService;

Creates new SchemaService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
SchemaService

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

createSchema(request, callback)

public createSchema(request: google.pubsub.v1.ICreateSchemaRequest, callback: google.pubsub.v1.SchemaService.CreateSchemaCallback): void;

Calls CreateSchema.

Parameters
Name Description
request ICreateSchemaRequest

CreateSchemaRequest message or plain object
callback CreateSchemaCallback

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

createSchema(request)

public createSchema(request: google.pubsub.v1.ICreateSchemaRequest): Promise<google.pubsub.v1.Schema>;

Calls CreateSchema.

Parameter
Name Description
request ICreateSchemaRequest

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

Promise

deleteSchema(request, callback)

public deleteSchema(request: google.pubsub.v1.IDeleteSchemaRequest, callback: google.pubsub.v1.SchemaService.DeleteSchemaCallback): void;

Calls DeleteSchema.

Parameters
Name Description
request IDeleteSchemaRequest

DeleteSchemaRequest message or plain object
callback DeleteSchemaCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteSchema(request)

public deleteSchema(request: google.pubsub.v1.IDeleteSchemaRequest): Promise<google.protobuf.Empty>;

Calls DeleteSchema.

Parameter
Name Description
request IDeleteSchemaRequest

DeleteSchemaRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteSchemaRevision(request, callback)

public deleteSchemaRevision(request: google.pubsub.v1.IDeleteSchemaRevisionRequest, callback: google.pubsub.v1.SchemaService.DeleteSchemaRevisionCallback): void;

Calls DeleteSchemaRevision.

Parameters
Name Description
request IDeleteSchemaRevisionRequest

DeleteSchemaRevisionRequest message or plain object
callback DeleteSchemaRevisionCallback

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

deleteSchemaRevision(request)

public deleteSchemaRevision(request: google.pubsub.v1.IDeleteSchemaRevisionRequest): Promise<google.pubsub.v1.Schema>;

Calls DeleteSchemaRevision.

Parameter
Name Description
request IDeleteSchemaRevisionRequest

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

Promise

getSchema(request, callback)

public getSchema(request: google.pubsub.v1.IGetSchemaRequest, callback: google.pubsub.v1.SchemaService.GetSchemaCallback): void;

Calls GetSchema.

Parameters
Name Description
request IGetSchemaRequest

GetSchemaRequest message or plain object
callback GetSchemaCallback

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

getSchema(request)

public getSchema(request: google.pubsub.v1.IGetSchemaRequest): Promise<google.pubsub.v1.Schema>;

Calls GetSchema.

Parameter
Name Description
request IGetSchemaRequest

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

Promise

listSchemaRevisions(request, callback)

public listSchemaRevisions(request: google.pubsub.v1.IListSchemaRevisionsRequest, callback: google.pubsub.v1.SchemaService.ListSchemaRevisionsCallback): void;

Calls ListSchemaRevisions.

Parameters
Name Description
request IListSchemaRevisionsRequest

ListSchemaRevisionsRequest message or plain object
callback ListSchemaRevisionsCallback

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

listSchemaRevisions(request)

public listSchemaRevisions(request: google.pubsub.v1.IListSchemaRevisionsRequest): Promise<google.pubsub.v1.ListSchemaRevisionsResponse>;

Calls ListSchemaRevisions.

Parameter
Name Description
request IListSchemaRevisionsRequest

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

Promise

listSchemas(request, callback)

public listSchemas(request: google.pubsub.v1.IListSchemasRequest, callback: google.pubsub.v1.SchemaService.ListSchemasCallback): void;

Calls ListSchemas.

Parameters
Name Description
request IListSchemasRequest

ListSchemasRequest message or plain object
callback ListSchemasCallback

Node-style callback called with the error, if any, and ListSchemasResponse
Returns
Type Description
void

listSchemas(request)

public listSchemas(request: google.pubsub.v1.IListSchemasRequest): Promise<google.pubsub.v1.ListSchemasResponse>;

Calls ListSchemas.

Parameter
Name Description
request IListSchemasRequest

ListSchemasRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.ListSchemasResponse>

Promise

rollbackSchema(request, callback)

public rollbackSchema(request: google.pubsub.v1.IRollbackSchemaRequest, callback: google.pubsub.v1.SchemaService.RollbackSchemaCallback): void;

Calls RollbackSchema.

Parameters
Name Description
request IRollbackSchemaRequest

RollbackSchemaRequest message or plain object
callback RollbackSchemaCallback

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

rollbackSchema(request)

public rollbackSchema(request: google.pubsub.v1.IRollbackSchemaRequest): Promise<google.pubsub.v1.Schema>;

Calls RollbackSchema.

Parameter
Name Description
request IRollbackSchemaRequest

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

Promise

validateMessage(request, callback)

public validateMessage(request: google.pubsub.v1.IValidateMessageRequest, callback: google.pubsub.v1.SchemaService.ValidateMessageCallback): void;

Calls ValidateMessage.

Parameters
Name Description
request IValidateMessageRequest

ValidateMessageRequest message or plain object
callback ValidateMessageCallback

Node-style callback called with the error, if any, and ValidateMessageResponse
Returns
Type Description
void

validateMessage(request)

public validateMessage(request: google.pubsub.v1.IValidateMessageRequest): Promise<google.pubsub.v1.ValidateMessageResponse>;

Calls ValidateMessage.

Parameter
Name Description
request IValidateMessageRequest

ValidateMessageRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.ValidateMessageResponse>

Promise

validateSchema(request, callback)

public validateSchema(request: google.pubsub.v1.IValidateSchemaRequest, callback: google.pubsub.v1.SchemaService.ValidateSchemaCallback): void;

Calls ValidateSchema.

Parameters
Name Description
request IValidateSchemaRequest

ValidateSchemaRequest message or plain object
callback ValidateSchemaCallback

Node-style callback called with the error, if any, and ValidateSchemaResponse
Returns
Type Description
void

validateSchema(request)

public validateSchema(request: google.pubsub.v1.IValidateSchemaRequest): Promise<google.pubsub.v1.ValidateSchemaResponse>;

Calls ValidateSchema.

Parameter
Name Description
request IValidateSchemaRequest

ValidateSchemaRequest message or plain object
Returns
Type Description
Promise<google.pubsub.v1.ValidateSchemaResponse>

Promise