Package com.google.cloud.servicedirectory.v1

Interface ResolveServiceRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ResolveServiceRequest, ResolveServiceRequest.Builder
@Generated public interface ResolveServiceRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEndpointFilter()
    Optional.
    com.google.protobuf.ByteString
    getEndpointFilterBytes()
    Optional.
    int
    getMaxEndpoints()
    Optional.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       Required. The name of the service to resolve.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the service to resolve.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getMaxEndpoints

      int 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.
      int32 max_endpoints = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The maxEndpoints.

    • getEndpointFilter

      String 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](https://aip.dev/160).
      string endpoint_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The endpointFilter.

    • getEndpointFilterBytes

      com.google.protobuf.ByteString getEndpointFilterBytes()
       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](https://aip.dev/160).
      string endpoint_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for endpointFilter.