Class: Google::Cloud::ServiceDirectory::V1beta1::ListServicesRequest

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

Overview

The request message for RegistrationService.ListServices.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Optional. The filter to list results by.

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

  • <field> can be name or metadata.<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:

  • metadata.owner returns services that have a metadata 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-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
  • metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata 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
  • attributes.managed_registration=true returns services that are managed by a GCP product or service

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 metadata.<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:

    • metadata.owner returns services that have a metadata 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-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
    • metadata.owner!=sd AND metadata.foo=bar returns services that have owner in metadata 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
    • attributes.managed_registration=true returns services that are managed by a GCP product or service

    For more information about filtering, see API Filtering.



238
239
240
241
 
# File 'proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb', line 238

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

#order_by ⇒ ::String

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



238
239
240
241
 
# File 'proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb', line 238

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

#page_size ⇒ ::Integer

Returns Optional. The maximum number of items to return. The default value is 100.

Returns:

  • (::Integer) —

    Optional. The maximum number of items to return. The default value is 100.



238
239
240
241
 
# File 'proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb', line 238

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.



238
239
240
241
 
# File 'proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb', line 238

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

#parent ⇒ ::String

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



238
239
240
241
 
# File 'proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb', line 238

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