Google Cloud Vmware Engine V1 Client - Class ListNetworkPoliciesRequest (0.3.3)

Version 0.3.3

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.5.6
• 0.4.0
• 0.3.3
• 0.2.1
• 0.1.4

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListNetworkPoliciesRequest.

Request message for VmwareEngine.ListNetworkPolicies

Generated from protobuf message google.cloud.vmwareengine.v1.ListNetworkPoliciesRequest

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name of the location (region) to query for network policies. 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
↳ page_size	int The maximum number of network policies 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 ListNetworkPolicies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNetworkPolicies 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 network policies, you can exclude the ones named example-policy by specifying name != "example-policy". To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-policy") (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-policy-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-policy-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 location (region) to query for network policies. 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

Returns
Type	Description
string

setParent

Required. The resource name of the location (region) to query for network policies. 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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

The maximum number of network policies 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.

Returns
Type	Description
int

setPageSize

The maximum number of network policies 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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

A page token, received from a previous ListNetworkPolicies call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNetworkPolicies must match the call that provided the page token.

Returns
Type	Description
string

setPageToken

A page token, received from a previous ListNetworkPolicies call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNetworkPolicies 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 policies, you can exclude the ones named example-policy by specifying name != "example-policy". To filter on multiple expressions, provide each separate expression within parentheses. For example:

(name = "example-policy")
(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-policy-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-policy-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 policies, you can exclude the ones named example-policy by specifying name != "example-policy". To filter on multiple expressions, provide each separate expression within parentheses. For example:

(name = "example-policy")
(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-policy-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-policy-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

static::build

Parameter
Name	Description
parent	string Required. The resource name of the location (region) to query for network policies. 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 Please see Google\Cloud\VmwareEngine\V1\VmwareEngineClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\VmwareEngine\V1\ListNetworkPoliciesRequest