Class ListEndpointsRequest (1.3.0) 

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

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

Inheritance

Object > ListEndpointsRequest

Namespace

Google.Cloud.ServiceDirectory.V1

Assembly

Google.Cloud.ServiceDirectory.V1.dll

Constructors

ListEndpointsRequest()

public ListEndpointsRequest()

ListEndpointsRequest(ListEndpointsRequest)

public ListEndpointsRequest(ListEndpointsRequest other)
Parameter
NameDescription
otherListEndpointsRequest

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", "address", "port" 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 Endpoints that have a label with the key "owner" this is the same as "metadata:owner".
  • "metadata.protocol=gRPC" returns Endpoints that have key/value "protocol=gRPC".
  • "address=192.108.1.105" returns Endpoints that have this address.
  • "port>8080" returns Endpoints that have port number larger than 8080.
  • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c" returns Endpoints that have name that is alphabetically later than the string, so "endpoint-e" will be returned but "endpoint-a" will not be.
  • "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints 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 Endpoint doesn't have a field called "doesnotexist". Since the filter does not match any Endpoints, it returns no results.
Property Value
TypeDescription
String

OrderBy

public string OrderBy { get; set; }

Optional. The order to list result by.

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 service whose endpoints we'd like to list.

Property Value
TypeDescription
String

ParentAsServiceName

public ServiceName ParentAsServiceName { get; set; }

ServiceName-typed view over the Parent resource name property.

Property Value
TypeDescription
ServiceName