Reference documentation and code samples for the Google Cloud Service Directory V1 Client class ListServicesRequest.
The request message for RegistrationService.ListServices .
Generated from protobuf message google.cloud.servicedirectory.v1.ListServicesRequest
Namespace
Google \ Cloud \ ServiceDirectory \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the namespace whose services 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 filter
string syntax: <field> <operator> <value> (<logical connector>)
* * <field>
can be name
or annotations.<key>
for map field * * <operator>
can be <
, >
, <=
, >=
, !=
, =
, :
. Of which :
means HAS
, and is roughly the same as =
* * <value>
must be the same data type as field * * <logical connector>
can be AND
, OR
, NOT
Examples of valid filters: * * annotations.owner
returns services that have a annotation with the key owner
, this is the same as annotations:owner
* * annotations.protocol=gRPC
returns services that have key/value protocol=gRPC
* name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c
returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not * * annotations.owner!=sd AND annotations.foo=bar
returns services that have owner
in annotation key but value is not sd
AND have key/value foo=bar
* * doesnotexist.foo=bar
returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results For more information about filtering, see API Filtering
.
↳ order_by
string
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 empty order_by
string results in default order, which is order by name
in ascending order.
getParent
Required. The resource name of the namespace whose services you'd like to list.
string
setParent
Required. The resource name of the namespace whose services you'd like to list.
var
string
$this
getPageSize
Optional. The maximum number of items to return.
int
setPageSize
Optional. The maximum number of items to return.
var
int
$this
getPageToken
Optional. The next_page_token value returned from a previous List request, if any.
string
setPageToken
Optional. The next_page_token value returned from a previous List request, if any.
var
string
$this
getFilter
Optional. The filter to list results by.
General filter
string syntax: <field> <operator> <value> (<logical connector>)
-
<field>
can bename
orannotations.<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: -
annotations.owner
returns services that have a annotation with the keyowner
, this is the same asannotations:owner
-
annotations.protocol=gRPC
returns services that have key/valueprotocol=gRPC
*name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c
returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not -
annotations.owner!=sd AND annotations.foo=bar
returns services that haveowner
in annotation key but value is notsd
AND have key/valuefoo=bar
-
doesnotexist.foo=bar
returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results For more information about filtering, see API Filtering .
string
setFilter
Optional. The filter to list results by.
General filter
string syntax: <field> <operator> <value> (<logical connector>)
-
<field>
can bename
orannotations.<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: -
annotations.owner
returns services that have a annotation with the keyowner
, this is the same asannotations:owner
-
annotations.protocol=gRPC
returns services that have key/valueprotocol=gRPC
*name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c
returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not -
annotations.owner!=sd AND annotations.foo=bar
returns services that haveowner
in annotation key but value is notsd
AND have key/valuefoo=bar
-
doesnotexist.foo=bar
returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results For more information about filtering, see API Filtering .
var
string
$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.
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.
var
string
$this
static::build
parent
string
Required. The resource name of the namespace whose services you'd like to list. Please see RegistrationServiceClient::namespaceName() for help formatting this field.