Class ProjectsResource.LocationsResource.NamespacesResource.ServicesResource.EndpointsResource.ListRequest
Lists all endpoints.
Inheritance
Inherited Members
Namespace: Google.Apis.ServiceDirectory.v1beta1
Assembly: Google.Apis.ServiceDirectory.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.NamespacesResource.ServicesResource.EndpointsResource.ListRequest : ServiceDirectoryBaseServiceRequest<ListEndpointsResponse>, IClientServiceRequest<ListEndpointsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
Filter
Optional. The filter to list results by. General filter
string syntax: ()
* can be `name`, `address`, `port`, `metadata.` for map field, or `attributes.` for attributes field *
can be <
, >
, <=
, >=
, !=
, =
, :
. Of
which :
means HAS
, and is roughly the same as =
* must be the same data type as field *
can be AND
, OR
, NOT
Examples of valid filters: * metadata.owner
returns endpoints that have a metadata 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-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c
returns endpoints that have name that is alphabetically later than the string, so
"endpoint-e" is returned but "endpoint-a" is not * metadata.owner!=sd AND metadata.foo=bar
returns endpoints 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 endpoint doesn't have a field called "doesnotexist". Since the filter does not
match any endpoints, it returns no results *
attributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP
returns
endpoints with the corresponding kubernetes_resource_type For more information about
filtering, see API Filtering.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
OrderBy
Optional. The order to list results by. General order_by
string syntax: () (,)
* allows values: `name`, `address`, `port` *
ascending or descending order by ``. 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.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
PageSize
Optional. The maximum number of items to return. The default value is 100.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
Optional. The next_page_token value returned from a previous List request, if any.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. The resource name of the service whose endpoints you'd like to list.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()