Class protos.google.pubsub.v1.UpdateSnapshotRequest (2.13.0)

Represents an UpdateSnapshotRequest.

Package

@google-cloud/pubsub!

Constructors

(constructor)(properties)

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

Constructs a new UpdateSnapshotRequest.

Parameter

Name	Description
properties	`IUpdateSnapshotRequest` Properties to set

Properties

snapshot

public snapshot?: (google.pubsub.v1.ISnapshot|null);

UpdateSnapshotRequest snapshot.

Property Value

Type	Description
(google.pubsub.v1.ISnapshot\|null)

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateSnapshotRequest updateMask.

Property Value

Type	Description
(google.protobuf.IFieldMask\|null)

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IUpdateSnapshotRequest): google.pubsub.v1.UpdateSnapshotRequest;

Creates a new UpdateSnapshotRequest instance using the specified properties.

Parameter

Name	Description
properties	`IUpdateSnapshotRequest` Properties to set

Returns

Type	Description
google.pubsub.v1.UpdateSnapshotRequest	UpdateSnapshotRequest instance

decode(reader, length)

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

Decodes an UpdateSnapshotRequest 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.UpdateSnapshotRequest	UpdateSnapshotRequest

decodeDelimited(reader)

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

Decodes an UpdateSnapshotRequest 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.UpdateSnapshotRequest	UpdateSnapshotRequest

encode(message, writer)

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

Encodes the specified UpdateSnapshotRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IUpdateSnapshotRequest` UpdateSnapshotRequest 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.IUpdateSnapshotRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IUpdateSnapshotRequest` UpdateSnapshotRequest 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.UpdateSnapshotRequest;

Creates an UpdateSnapshotRequest 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.UpdateSnapshotRequest	UpdateSnapshotRequest

toJSON()

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

Converts this UpdateSnapshotRequest to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.pubsub.v1.UpdateSnapshotRequest` UpdateSnapshotRequest
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 an UpdateSnapshotRequest 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