Service Directory V1 API - Class Google::Cloud::ServiceDirectory::V1::ListServicesRequest (v1.0.1)

Reference documentation and code samples for the Service Directory V1 API class Google::Cloud::ServiceDirectory::V1::ListServicesRequest.

The request message for RegistrationService.ListServices.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — 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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#order_by

def order_by() -> ::String
Returns
  • (::String) — 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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of items to return.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of items to return.
Returns
  • (::Integer) — Optional. The maximum number of items to return.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. The next_page_token value returned from a previous List request, if any.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The next_page_token value returned from a previous List request, if any.
Returns
  • (::String) — Optional. The next_page_token value returned from a previous List request, if any.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the namespace whose services you'd like to list.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the namespace whose services you'd like to list.
Returns
  • (::String) — Required. The resource name of the namespace whose services you'd like to list.