Service Directory v1beta1 API - Class ListServicesRequest (2.0.0-beta03) 

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

Reference documentation and code samples for the Service Directory v1beta1 API class ListServicesRequest.

The request message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

Inheritance

object > ListServicesRequest

Namespace

Google.Cloud.ServiceDirectory.V1Beta1

Assembly

Google.Cloud.ServiceDirectory.V1Beta1.dll

Constructors

ListServicesRequest()

public ListServicesRequest()

ListServicesRequest(ListServicesRequest)

public ListServicesRequest(ListServicesRequest other)
Parameter
NameDescription
otherListServicesRequest

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 metadata.<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:

  • metadata.owner returns services that have a metadata with the key owner, this is the same as metadata:owner
  • metadata.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
  • metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata 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
  • attributes.managed_registration=true returns services that are managed by a GCP product or service

For more information about filtering, see API Filtering.

Property Value
TypeDescription
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
TypeDescription
string

PageSize

public int PageSize { get; set; }

Optional. The maximum number of items to return.

Property Value
TypeDescription
int

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 namespace whose services you'd like to list.

Property Value
TypeDescription
string

ParentAsNamespaceName

public NamespaceName ParentAsNamespaceName { get; set; }

NamespaceName-typed view over the Parent resource name property.

Property Value
TypeDescription
NamespaceName