Class protos.google.cloud.compute.v1.ListRegionInstantSnapshotsRequest (4.5.0)

Represents a ListRegionInstantSnapshotsRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IListRegionInstantSnapshotsRequest);

Constructs a new ListRegionInstantSnapshotsRequest.

Parameter
Name Description
properties IListRegionInstantSnapshotsRequest

Properties to set

Properties

_filter

public _filter?: "filter";

ListRegionInstantSnapshotsRequest _filter.

_maxResults

public _maxResults?: "maxResults";

ListRegionInstantSnapshotsRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

ListRegionInstantSnapshotsRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

ListRegionInstantSnapshotsRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

ListRegionInstantSnapshotsRequest _returnPartialSuccess.

filter

public filter?: (string|null);

ListRegionInstantSnapshotsRequest filter.

maxResults

public maxResults?: (number|null);

ListRegionInstantSnapshotsRequest maxResults.

orderBy

public orderBy?: (string|null);

ListRegionInstantSnapshotsRequest orderBy.

pageToken

public pageToken?: (string|null);

ListRegionInstantSnapshotsRequest pageToken.

project

public project: string;

ListRegionInstantSnapshotsRequest project.

region

public region: string;

ListRegionInstantSnapshotsRequest region.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

ListRegionInstantSnapshotsRequest returnPartialSuccess.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IListRegionInstantSnapshotsRequest): google.cloud.compute.v1.ListRegionInstantSnapshotsRequest;

Creates a new ListRegionInstantSnapshotsRequest instance using the specified properties.

Parameter
Name Description
properties IListRegionInstantSnapshotsRequest

Properties to set

Returns
Type Description
ListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest instance

decode(reader, length)

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

Decodes a ListRegionInstantSnapshotsRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
ListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.ListRegionInstantSnapshotsRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IListRegionInstantSnapshotsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListRegionInstantSnapshotsRequest message. Does not implicitly messages.

Parameters
Name Description
message IListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest 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.cloud.compute.v1.IListRegionInstantSnapshotsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest 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.cloud.compute.v1.ListRegionInstantSnapshotsRequest;

Creates a ListRegionInstantSnapshotsRequest 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
ListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListRegionInstantSnapshotsRequest

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 ListRegionInstantSnapshotsRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ListRegionInstantSnapshotsRequest

ListRegionInstantSnapshotsRequest

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 ListRegionInstantSnapshotsRequest 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