Service Directory V1 API - Class Google::Cloud::ServiceDirectory::V1::ListServicesRequest (v0.4.0)

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 result by.

    General filter string syntax:

    Examples of valid filters:

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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    Optional. The filter to list result by.

    General filter string syntax:

    Examples of valid filters:

    • "metadata.owner" returns Services that have a label with the key "owner" this is the same as "metadata:owner".
    • "metadata.protocol=gRPC" returns Services that have key/value "protocol=gRPC".
    • "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c" returns Services that have name that is alphabetically later than the string, so "service-e" will be returned but "service-a" will not be.
    • "metadata.owner!=sd AND metadata.foo=bar" returns Services 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 Service doesn't have a field called "doesnotexist". Since the filter does not match any Services, it returns no results.
Returns
  • (::String) —

    Optional. The filter to list result by.

    General filter string syntax:

    Examples of valid filters:

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

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. The order to list result by.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. The order to list result by.
Returns
  • (::String) — Optional. The order to list result by.

#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 we'd like to list.

#parent=

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