Class protos.google.pubsub.v1.SchemaSettings (3.1.1)

Represents a SchemaSettings.

Package

@google-cloud/pubsub

Constructors

(constructor)(properties)

constructor(properties?: google.pubsub.v1.ISchemaSettings);

Constructs a new SchemaSettings.

Parameter
Name Description
properties ISchemaSettings

Properties to set

Properties

encoding

public encoding: (google.pubsub.v1.Encoding|keyof typeof google.pubsub.v1.Encoding);

SchemaSettings encoding.

schema

public schema: string;

SchemaSettings schema.

Methods

create(properties)

public static create(properties?: google.pubsub.v1.ISchemaSettings): google.pubsub.v1.SchemaSettings;

Creates a new SchemaSettings instance using the specified properties.

Parameter
Name Description
properties ISchemaSettings

Properties to set
Returns
Type Description
google.pubsub.v1.SchemaSettings

SchemaSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.SchemaSettings;

Decodes a SchemaSettings message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.pubsub.v1.SchemaSettings

SchemaSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.SchemaSettings;

Decodes a SchemaSettings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.pubsub.v1.SchemaSettings

SchemaSettings

encode(message, writer)

public static encode(message: google.pubsub.v1.ISchemaSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SchemaSettings message. Does not implicitly messages.

Parameters
Name Description
message ISchemaSettings

SchemaSettings message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.pubsub.v1.ISchemaSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SchemaSettings message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ISchemaSettings

SchemaSettings message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.pubsub.v1.SchemaSettings;

Creates a SchemaSettings message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
google.pubsub.v1.SchemaSettings

SchemaSettings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SchemaSettings

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this SchemaSettings to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.pubsub.v1.SchemaSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SchemaSettings message. Also converts values to other types if specified.

Parameters
Name Description
message google.pubsub.v1.SchemaSettings

SchemaSettings
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SchemaSettings message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not