Google Cloud Service Directory V1 Client - Class ListNamespacesRequest (1.0.5)

Reference documentation and code samples for the Google Cloud Service Directory V1 Client class ListNamespacesRequest.

The request message for RegistrationService.ListNamespaces .

Generated from protobuf message google.cloud.servicedirectory.v1.ListNamespacesRequest

Methods

__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 we'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 result by. General filter string syntax:

↳ order_by
string

Optional. The order to list result by. General order by string syntax:

getParent

Required. The resource name of the project and location whose namespaces we'd like to list.

Returns
Type
Description
string

setParent

Required. The resource name of the project and location whose namespaces we'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 result by.

General filter string syntax:

  • "labels.owner" returns Namespaces that have a label with the key "owner" this is the same as "labels:owner".
  • "labels.protocol=gRPC" returns Namespaces that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/namespace-c" returns Namespaces that have name that is alphabetically later than the string, so "namespace-e" will be returned but "namespace-a" will not be.
  • "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have "owner" in label key but value is not "sd" AND have key/value foo=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.
Returns
Type
Description
string

setFilter

Optional. The filter to list result by.

General filter string syntax:

  • "labels.owner" returns Namespaces that have a label with the key "owner" this is the same as "labels:owner".
  • "labels.protocol=gRPC" returns Namespaces that have key/value "protocol=gRPC".
  • "name>projects/my-project/locations/us-east/namespaces/namespace-c" returns Namespaces that have name that is alphabetically later than the string, so "namespace-e" will be returned but "namespace-a" will not be.
  • "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have "owner" in label key but value is not "sd" AND have key/value foo=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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOrderBy

Optional. The order to list result by.

General order by string syntax:

Returns
Type
Description
string

setOrderBy

Optional. The order to list result by.

General order by string syntax:

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: