Reference documentation and code samples for the Google Cloud Service Directory V1 Client class ListEndpointsRequest.
The request message for RegistrationService.ListEndpoints.
Generated from protobuf message google.cloud.servicedirectory.v1.ListEndpointsRequest
Namespace
Google \ Cloud \ ServiceDirectory \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the service whose endpoints we'd like to list. |
↳ page_size |
int
Optional. The maximum number of items to return. |
↳ page_token |
string
Optional. The next_page_token value returned from a previous List request, if any. |
↳ filter |
string
Optional. The filter to list result by. General filter string syntax:
|
↳ order_by |
string
Optional. The order to list result by. |
getParent
Required. The resource name of the service whose endpoints we'd like to list.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the service whose endpoints we'd like to list.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. The maximum number of items to return.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. The maximum number of items to return.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. The next_page_token value returned from a previous List request, if any.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. The next_page_token value returned from a previous List request, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. The filter to list result by.
General filter string syntax:
- "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.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. The filter to list result by.
General filter string syntax:
- "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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Optional. The order to list result by.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Optional. The order to list result by.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the service whose endpoints we'd like to list. Please see Google\Cloud\ServiceDirectory\V1\RegistrationServiceClient::serviceName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ServiceDirectory\V1\ListEndpointsRequest | |