Lists all endpoints.
Scopes
You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: servicedirectory1 --scope <scope> projects locations-namespaces-services-endpoints-list ...
Required Scalar Argument
- <parent> (string)
- Required. The resource name of the service whose endpoints you'd like to list.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p filter=string
- Optional. The filter to list results by. General
filter
string syntax:()
*can be `name`, `address`, `port`, or `annotations.` for map field *
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
*must be the same data type as field *
can beAND
,OR
,NOT
Examples of valid filters: *annotations.owner
returns endpoints that have a annotation with the keyowner
, this is the same asannotations:owner
*annotations.protocol=gRPC
returns endpoints that have key/valueprotocol=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 *annotations.owner!=sd AND annotations.foo=bar
returns endpoints that haveowner
in annotation key but value is notsd
AND have key/valuefoo=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 For more information about filtering, see API Filtering.
- Optional. The filter to list results by. General
-
-p order-by=string
- 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,
ascis used Note that an empty
order_bystring results in default order, which is order by
name` in ascending order.
- Optional. The order to list results by. General
-
-p page-size=integer
- Optional. The maximum number of items to return.
-
-p page-token=string
- Optional. The next_page_token value returned from a previous List request, if any.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").