Service Directory v1 API - Class ListNamespacesRequest (2.1.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
NameDescription
otherListNamespacesRequest

Properties

Filter

public string Filter { get; set; }

Optional. The filter to list result 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.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.
Property Value
TypeDescription
String

OrderBy

public string OrderBy { get; set; }

Optional. The order to list result by.

General order by string syntax: <field> (<asc|desc>) (,) <field> allows values {"name"} <asc/desc> ascending or descending order by <field>. If this is left blank, "asc" is used. Note that an empty order_by string result in default order, which is order by name in ascending order.

Property Value
TypeDescription
String

PageSize

public int PageSize { get; set; }

Optional. The maximum number of items to return.

Property Value
TypeDescription
Int32

PageToken

public string PageToken { get; set; }

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

Property Value
TypeDescription
String

Parent

public string Parent { get; set; }

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

Property Value
TypeDescription
String

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
TypeDescription
LocationName