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