Google Cloud Service Directory V1 Client - Class ResolveServiceRequest (2.0.3)

Reference documentation and code samples for the Google Cloud Service Directory V1 Client class ResolveServiceRequest.

The request message for LookupService.ResolveService.

Looks up a service by its name, returns the service and its endpoints.

Generated from protobuf message google.cloud.servicedirectory.v1.ResolveServiceRequest

Namespace

Google \ Cloud \ ServiceDirectory \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The name of the service to resolve.
`↳ max_endpoints`	`int` Optional. The maximum number of endpoints to return. Defaults to 25. Maximum is 100. If a value less than one is specified, the Default is used. If a value greater than the Maximum is specified, the Maximum is used.
`↳ endpoint_filter`	`string` Optional. The filter applied to the endpoints of the resolved service. General `filter` string syntax: `<field> <operator> <value> (<logical connector>)` * * `<field>` can be `name`, `address`, `port`, or `annotations.<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: * * `annotations.owner` returns endpoints that have a annotation with the key `owner`, this is the same as `annotations:owner` * * `annotations.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 * `name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1` returns the endpoint that has an endpoint_id equal to `ep-1` * * `annotations.owner!=sd AND annotations.foo=bar` returns endpoints that have `owner` in annotation 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 endpoint, it returns no results For more information about filtering, see API Filtering.

getName

Required. The name of the service to resolve.

Returns
Type	Description
`string`

setName

Required. The name of the service to resolve.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMaxEndpoints

Optional. The maximum number of endpoints to return. Defaults to 25.

Maximum is 100. If a value less than one is specified, the Default is used. If a value greater than the Maximum is specified, the Maximum is used.

Returns
Type	Description
`int`

setMaxEndpoints

Optional. The maximum number of endpoints to return. Defaults to 25.

Maximum is 100. If a value less than one is specified, the Default is used. If a value greater than the Maximum is specified, the Maximum is used.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEndpointFilter

Optional. The filter applied to the endpoints of the resolved service.

General filter string syntax: <field> <operator> <value> (<logical connector>)

<field> can be name, address, port, or annotations.<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:
annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner
annotations.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 * name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1 returns the endpoint that has an endpoint_id equal to ep-1
annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation 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 endpoint, it returns no results For more information about filtering, see API Filtering.

Returns
Type	Description
`string`

setEndpointFilter

Optional. The filter applied to the endpoints of the resolved service.

General filter string syntax: <field> <operator> <value> (<logical connector>)

<field> can be name, address, port, or annotations.<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:
annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner
annotations.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 * name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1 returns the endpoint that has an endpoint_id equal to ep-1
annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation 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 endpoint, it returns no results For more information about filtering, see API Filtering.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`