Reference documentation and code samples for the Google Cloud Service Directory V1beta1 Client class ListNamespacesRequest.
The request message for RegistrationService.ListNamespaces.
Generated from protobuf message google.cloud.servicedirectory.v1beta1.ListNamespacesRequest
Namespace
Google \ Cloud \ ServiceDirectory \ V1beta1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the project and location whose namespaces you'd like to list. |
↳ page_size |
int
Optional. The maximum number of items to return. |
↳ page_token |
string
Optional. The next_page_token value returned from a previous List request, if any. |
↳ filter |
string
Optional. The filter to list results by. General |
↳ order_by |
string
Optional. The order to list results by. General |
getParent
Required. The resource name of the project and location whose namespaces you'd like to list.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The resource name of the project and location whose namespaces you'd like to list.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. The maximum number of items to return.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. The maximum number of items to return.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. The next_page_token value returned from a previous List request, if any.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. The next_page_token value returned from a previous List request, if any.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Optional. The filter to list results by.
General filter
string syntax:
<field> <operator> <value> (<logical connector>)
<field>
can bename
orlabels.<key>
for map field<operator>
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
<value>
must be the same data type as field<logical connector>
can beAND
,OR
,NOT
Examples of valid filters:labels.owner
returns namespaces that have a label with the keyowner
, this is the same aslabels:owner
labels.owner=sd
returns namespaces that have key/valueowner=sd
name>projects/my-project/locations/us-east1/namespaces/namespace-c
returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is notlabels.owner!=sd AND labels.foo=bar
returns namespaces that haveowner
in label key but value is notsd
AND have key/valuefoo=bar
doesnotexist.foo=bar
returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results For more information about filtering, see API Filtering.
Returns | |
---|---|
Type | Description |
string |
setFilter
Optional. The filter to list results by.
General filter
string syntax:
<field> <operator> <value> (<logical connector>)
<field>
can bename
orlabels.<key>
for map field<operator>
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
<value>
must be the same data type as field<logical connector>
can beAND
,OR
,NOT
Examples of valid filters:labels.owner
returns namespaces that have a label with the keyowner
, this is the same aslabels:owner
labels.owner=sd
returns namespaces that have key/valueowner=sd
name>projects/my-project/locations/us-east1/namespaces/namespace-c
returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is notlabels.owner!=sd AND labels.foo=bar
returns namespaces that haveowner
in label key but value is notsd
AND have key/valuefoo=bar
doesnotexist.foo=bar
returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results For more information about filtering, see API Filtering.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
Optional. The order to list results by.
General order_by
string syntax: <field> (<asc|desc>) (,)
<field>
allows value:name
<asc|desc>
ascending or descending order by<field>
. If this is left blank,asc
is used Note that an emptyorder_by
string results in default order, which is order byname
in ascending order.
Returns | |
---|---|
Type | Description |
string |
setOrderBy
Optional. The order to list results by.
General order_by
string syntax: <field> (<asc|desc>) (,)
<field>
allows value:name
<asc|desc>
ascending or descending order by<field>
. If this is left blank,asc
is used Note that an emptyorder_by
string results in default order, which is order byname
in ascending order.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |