Reference documentation and code samples for the Google Cloud Network Management V1 Client class ListConnectivityTestsRequest.
Request for the ListConnectivityTests
method.
Generated from protobuf message google.cloud.networkmanagement.v1.ListConnectivityTestsRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource of the Connectivity Tests: |
↳ page_size |
int
Number of |
↳ page_token |
string
Page token from an earlier query, as returned in |
↳ filter |
string
Lists the
|
↳ order_by |
string
Field to use to sort the list. |
getParent
Required. The parent resource of the Connectivity Tests:
projects/{project_id}/locations/global
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The parent resource of the Connectivity Tests:
projects/{project_id}/locations/global
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Number of ConnectivityTests
to return.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Number of ConnectivityTests
to return.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Page token from an earlier query, as returned in next_page_token
.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Page token from an earlier query, as returned in next_page_token
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Lists the ConnectivityTests
that match the filter expression. A filter
expression filters the resources listed in the response. The expression
must be of the form <field> <operator> <value>
where operators: <
, >
,
<=
,
>=
,
!=
, =
, :
are supported (colon :
represents a HAS operator which is
roughly synonymous with equality).
Examples:
- Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1
- Filter by labels:
- Resources that have a key called
foo
labels.foo:* - Resources that have a key called
foo
whose value isbar
labels.foo = bar
- Resources that have a key called
Returns | |
---|---|
Type | Description |
string |
setFilter
Lists the ConnectivityTests
that match the filter expression. A filter
expression filters the resources listed in the response. The expression
must be of the form <field> <operator> <value>
where operators: <
, >
,
<=
,
>=
,
!=
, =
, :
are supported (colon :
represents a HAS operator which is
roughly synonymous with equality).
Examples:
- Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1
- Filter by labels:
- Resources that have a key called
foo
labels.foo:* - Resources that have a key called
foo
whose value isbar
labels.foo = bar
- Resources that have a key called
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
Field to use to sort the list.
Returns | |
---|---|
Type | Description |
string |
setOrderBy
Field to use to sort the list.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |