Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListVmwareEngineNetworksRequest.
Request message for VmwareEngine.ListVmwareEngineNetworks
Generated from protobuf message google.cloud.vmwareengine.v1.ListVmwareEngineNetworksRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the location to query for VMware Engine networks. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: |
↳ page_size |
int
The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500. |
↳ page_token |
string
A page token, received from a previous |
↳ filter |
string
A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be |
↳ order_by |
string
Sorts list results by a certain order. By default, returned results are ordered by |
getParent
Required. The resource name of the location to query for
VMware Engine networks. Resource names are schemeless URIs that follow the
conventions in https://cloud.google.com/apis/design/resource_names. For
example: projects/my-project/locations/global
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the location to query for
VMware Engine networks. Resource names are schemeless URIs that follow the
conventions in https://cloud.google.com/apis/design/resource_names. For
example: projects/my-project/locations/global
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The maximum number of results to return in one page.
The maximum value is coerced to 1000. The default value of this field is 500.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of results to return in one page.
The maximum value is coerced to 1000. The default value of this field is 500.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token, received from a previous ListVmwareEngineNetworks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListVmwareEngineNetworks must match the call that provided the page
token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token, received from a previous ListVmwareEngineNetworks call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListVmwareEngineNetworks must match the call that provided the page
token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
A filter expression that matches resources returned in the response.
The expression must specify the field name, a comparison
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The comparison operator
must be =, !=, >, or <.
For example, if you are filtering a list of network peerings, you can
exclude the ones named example-network by specifying
name != "example-network".
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(name = "example-network")
(createTime > "2021-04-12T08:15:10.40Z")
By default, each expression is an AND expression. However, you
can include AND and OR expressions explicitly.
For example:
(name = "example-network-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-network-2")
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
A filter expression that matches resources returned in the response.
The expression must specify the field name, a comparison
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The comparison operator
must be =, !=, >, or <.
For example, if you are filtering a list of network peerings, you can
exclude the ones named example-network by specifying
name != "example-network".
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(name = "example-network")
(createTime > "2021-04-12T08:15:10.40Z")
By default, each expression is an AND expression. However, you
can include AND and OR expressions explicitly.
For example:
(name = "example-network-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-network-2")
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Sorts list results by a certain order. By default, returned results
are ordered by name in ascending order.
You can also sort results in descending order based on the name value
using orderBy="name desc".
Currently, only ordering by name is supported.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Sorts list results by a certain order. By default, returned results
are ordered by name in ascending order.
You can also sort results in descending order based on the name value
using orderBy="name desc".
Currently, only ordering by name is supported.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |