Class Schema (4.4.0)

Package

Examples

Creating an instance of this class.

const {PubSub} = require('@google-cloud/pubsub');
const pubsub = new PubSub();

const schema = pubsub.schema('my-schema');

Getting the details of a schema. Note that Schema methods do not provide a callback interface. Use .then() or await.

const {PubSub} = require('@google-cloud/pubsub');
const pubsub = new PubSub();

const schema = pubsub.schema('my-schema');
schema.get(SchemaViews.Basic).then(console.log);

Constructors

(constructor)(pubsub, idOrName)

constructor(pubsub: PubSub, idOrName: string);

Properties

id

id: string;

name_

name_?: string;

pubsub

pubsub: PubSub;

Methods

create(type, definition, gaxOpts)

create(type: SchemaType, definition: string, gaxOpts?: CallOptions): Promise<void>;

Create a schema.

const {PubSub} = require('@google-cloud/pubsub');
const pubsub = new PubSub();

const schema = pubsub.schema('messageType');
await schema.create(
  SchemaTypes.Avro,
  '{...avro definition...}'
);

delete(gaxOpts)

delete(gaxOpts?: CallOptions): Promise<void>;

formatName_(projectId, nameOrId)

static formatName_(projectId: string, nameOrId: string): string;

get(view, gaxOpts)

get(view?: SchemaView, gaxOpts?: CallOptions): Promise<ISchema>;

getName()

getName(): Promise<string>;

metadataFromMessage(attributes)

static metadataFromMessage(attributes: Attributes): SchemaMessageMetadata;

validateMessage(message, encoding, gaxOpts)

validateMessage(message: string, encoding: google.pubsub.v1.Encoding | keyof typeof google.pubsub.v1.Encoding, gaxOpts?: CallOptions): Promise<void>;