Represents a ListRegionsRequest.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IListRegionsRequest);Constructs a new ListRegionsRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IListRegionsRequest
Properties to set |
Properties
_filter
public _filter?: "filter";ListRegionsRequest _filter.
_maxResults
public _maxResults?: "maxResults";ListRegionsRequest _maxResults.
_orderBy
public _orderBy?: "orderBy";ListRegionsRequest _orderBy.
_pageToken
public _pageToken?: "pageToken";ListRegionsRequest _pageToken.
_returnPartialSuccess
public _returnPartialSuccess?: "returnPartialSuccess";ListRegionsRequest _returnPartialSuccess.
filter
public filter?: (string|null);ListRegionsRequest filter.
maxResults
public maxResults?: (number|null);ListRegionsRequest maxResults.
orderBy
public orderBy?: (string|null);ListRegionsRequest orderBy.
pageToken
public pageToken?: (string|null);ListRegionsRequest pageToken.
project
public project: string;ListRegionsRequest project.
returnPartialSuccess
public returnPartialSuccess?: (boolean|null);ListRegionsRequest returnPartialSuccess.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IListRegionsRequest): google.cloud.compute.v1.ListRegionsRequest;Creates a new ListRegionsRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IListRegionsRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ListRegionsRequest |
ListRegionsRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.ListRegionsRequest;Decodes a ListRegionsRequest 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 |
ListRegionsRequest |
ListRegionsRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.ListRegionsRequest;Decodes a ListRegionsRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ListRegionsRequest |
ListRegionsRequest |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IListRegionsRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ListRegionsRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IListRegionsRequest
ListRegionsRequest 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.IListRegionsRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ListRegionsRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IListRegionsRequest
ListRegionsRequest 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.ListRegionsRequest;Creates a ListRegionsRequest 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 |
ListRegionsRequest |
ListRegionsRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ListRegionsRequest
| 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 ListRegionsRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.ListRegionsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ListRegionsRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ListRegionsRequest
ListRegionsRequest |
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 ListRegionsRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|