Package com.google.cloud.servicedirectory.v1

Interface ListServicesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListServicesRequest, ListServicesRequest.Builder
    public interface ListServicesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Optional.
      com.google.protobuf.ByteString getFilterBytes()
      Optional.
      String getOrderBy()
      Optional.
      com.google.protobuf.ByteString getOrderByBytes()
      Optional.
      int getPageSize()
      Optional.
      String getPageToken()
      Optional.
      com.google.protobuf.ByteString getPageTokenBytes()
      Optional.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      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 Detail

      • getParent

        String getParent()
         Required. The resource name of the namespace whose services you'd
 like to list.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the namespace whose services you'd
 like to list.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getPageSize

        int getPageSize()
         Optional. The maximum number of items to return.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         Optional. The next_page_token value returned from a previous List request,
 if any.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The next_page_token value returned from a previous List request,
 if any.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageToken.

      • getFilter

        String getFilter()
         Optional. The filter to list results by.

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

 *   `<field>` can be `name` 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 services that have a annotation with the
     key `owner`, this is the same as `annotations:owner`
 *   `annotations.protocol=gRPC` returns services that have key/value
     `protocol=gRPC`
 *
 `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c`
     returns services that have name that is alphabetically later than the
     string, so "service-e" is returned but "service-a" is not
 *   `annotations.owner!=sd AND annotations.foo=bar` returns services 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 service
     doesn't have a field called "doesnotexist". Since the filter does not
     match any services, it returns no results

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Optional. The filter to list results by.

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

 *   `<field>` can be `name` 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 services that have a annotation with the
     key `owner`, this is the same as `annotations:owner`
 *   `annotations.protocol=gRPC` returns services that have key/value
     `protocol=gRPC`
 *
 `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c`
     returns services that have name that is alphabetically later than the
     string, so "service-e" is returned but "service-a" is not
 *   `annotations.owner!=sd AND annotations.foo=bar` returns services 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 service
     doesn't have a field called "doesnotexist". Since the filter does not
     match any services, it returns no results

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for filter.

      • getOrderBy

        String getOrderBy()
         Optional. The order to list results by.

 General `order_by` string syntax: `<field> (<asc|desc>) (,)`

 *   `<field>` allows value: `name`
 *   `<asc|desc>` ascending or descending order by `<field>`. 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.
        string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         Optional. The order to list results by.

 General `order_by` string syntax: `<field> (<asc|desc>) (,)`

 *   `<field>` allows value: `name`
 *   `<asc|desc>` ascending or descending order by `<field>`. 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.
        string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for orderBy.