Service Directory v1 API - Class ListNamespacesRequest (2.5.0) 

public sealed class ListNamespacesRequest : IMessage<ListNamespacesRequest>, IEquatable<ListNamespacesRequest>, IDeepCloneable<ListNamespacesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Service Directory v1 API class ListNamespacesRequest.

The request message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1.RegistrationService.ListNamespaces].

Inheritance

object > ListNamespacesRequest

Namespace

Google.Cloud.ServiceDirectory.V1

Assembly

Google.Cloud.ServiceDirectory.V1.dll

Constructors

ListNamespacesRequest()

public ListNamespacesRequest()

ListNamespacesRequest(ListNamespacesRequest)

public ListNamespacesRequest(ListNamespacesRequest other)
Parameter
Name Description
other ListNamespacesRequest

Properties

Filter

public string Filter { get; set; }

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

  • <field> can be name or labels.<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:

  • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner
  • labels.owner=sd returns namespaces that have key/value owner=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 not
  • 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

For more information about filtering, see API Filtering.

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

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.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. The maximum number of items to return.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The next_page_token value returned from a previous List request, if any.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName