Class: Google::Cloud::ServiceDirectory::V1::ListServicesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/servicedirectory/v1/registration_service.rb

Overview

The request message for RegistrationService.ListServices.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Optional. The filter to list result by.

General filter string syntax: () can be "name", or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

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: () can be "name", or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT".

    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.


211
212
213
214
 
# File 'proto_docs/google/cloud/servicedirectory/v1/registration_service.rb', line 211

class ListServicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Optional. The order to list result by.

Returns:

  • (::String) —

    Optional. The order to list result by.



211
212
213
214
 
# File 'proto_docs/google/cloud/servicedirectory/v1/registration_service.rb', line 211

class ListServicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The maximum number of items to return.

Returns:

  • (::Integer) —

    Optional. The maximum number of items to return.



211
212
213
214
 
# File 'proto_docs/google/cloud/servicedirectory/v1/registration_service.rb', line 211

class ListServicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



211
212
213
214
 
# File 'proto_docs/google/cloud/servicedirectory/v1/registration_service.rb', line 211

class ListServicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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.



211
212
213
214
 
# File 'proto_docs/google/cloud/servicedirectory/v1/registration_service.rb', line 211

class ListServicesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end