Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListPrivateCloudsRequest.
Request message for VmwareEngine.ListPrivateClouds
Generated from protobuf message google.cloud.vmwareengine.v1.ListPrivateCloudsRequest
Namespace
Google \ Cloud \ VmwareEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names
. For example: projects/my-project/locations/us-central1-a
↳ page_size
int
The maximum number of private clouds to return in one page. The service may return fewer than this value. 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 ListPrivateClouds
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPrivateClouds
must match the call that provided the page token.
↳ 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 =
, !=
, >
, or <
. For example, if you are filtering a list of private clouds, you can exclude the ones named example-pc
by specifying name != "example-pc"
. You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24"
to include private clouds only if they have a matching address in their network configuration. To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-pc") (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 = "private-cloud-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "private-cloud-2")
↳ order_by
string
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.
getParent
Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names .
For example: projects/my-project/locations/us-central1-a
string
setParent
Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names .
For example: projects/my-project/locations/us-central1-a
var
string
$this
getPageSize
The maximum number of private clouds to return in one page.
The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
int
setPageSize
The maximum number of private clouds to return in one page.
The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
var
int
$this
getPageToken
A page token, received from a previous ListPrivateClouds
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPrivateClouds
must
match the call that provided the page token.
string
setPageToken
A page token, received from a previous ListPrivateClouds
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPrivateClouds
must
match the call that provided the page token.
var
string
$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 private clouds, you can exclude
the ones named example-pc
by specifying name != "example-pc"
.
You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24"
to include private clouds
only if they have a matching address in their network configuration.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(name = "example-pc")
(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 = "private-cloud-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "private-cloud-2")
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 private clouds, you can exclude
the ones named example-pc
by specifying name != "example-pc"
.
You can also filter nested fields. For example, you could specify networkConfig.managementCidr = "192.168.0.0/24"
to include private clouds
only if they have a matching address in their network configuration.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(name = "example-pc")
(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 = "private-cloud-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "private-cloud-2")
var
string
$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.
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.
var
string
$this
static::build
parent
string
Required. The resource name of the private cloud to be queried for
clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names
.
For example: projects/my-project/locations/us-central1-a
Please see VmwareEngineClient::locationName()
for help formatting this field.
