Class protos.google.pubsub.v1.GetSchemaRequest

Represents a GetSchemaRequest.

Package

@google-cloud/pubsub

Constructors

(constructor)(properties)

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

Constructs a new GetSchemaRequest.

Parameter
NameDescription
properties google.pubsub.v1.IGetSchemaRequest

Properties to set

Properties

name

public name: string;

GetSchemaRequest name.

Property Value
TypeDescription
string

view

public view: (google.pubsub.v1.SchemaView|keyof typeof google.pubsub.v1.SchemaView);

GetSchemaRequest view.

Property Value
TypeDescription
(google.pubsub.v1.SchemaView|keyof typeof google.pubsub.v1.SchemaView)

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IGetSchemaRequest): google.pubsub.v1.GetSchemaRequest;

Creates a new GetSchemaRequest instance using the specified properties.

Parameter
NameDescription
properties google.pubsub.v1.IGetSchemaRequest

Properties to set

Returns
TypeDescription
google.pubsub.v1.GetSchemaRequest

GetSchemaRequest instance

decode(reader, length)

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

Decodes a GetSchemaRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.pubsub.v1.GetSchemaRequest

GetSchemaRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.pubsub.v1.GetSchemaRequest

GetSchemaRequest

encode(message, writer)

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

Encodes the specified GetSchemaRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.pubsub.v1.IGetSchemaRequest

GetSchemaRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message google.pubsub.v1.IGetSchemaRequest

GetSchemaRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.pubsub.v1.GetSchemaRequest

GetSchemaRequest

toJSON()

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

Converts this GetSchemaRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.pubsub.v1.GetSchemaRequest

GetSchemaRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a GetSchemaRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not