Service Directory V1beta1 API - Class Google::Cloud::ServiceDirectory::V1beta1::ListNamespacesRequest (v0.15.0)

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

The request message for RegistrationService.ListNamespaces.

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, labels.<key> for map field, or attributes.<field> for attributes 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:

    • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner
    • labels.owner=sd returns namespaces that have key/value owner=sd
    • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
    • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
    • attributes.managed_registration=true returns namespaces that are managed by a GCP product or service

    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, labels.<key> for map field, or attributes.<field> for attributes 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:

    • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner
    • labels.owner=sd returns namespaces that have key/value owner=sd
    • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
    • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
    • attributes.managed_registration=true returns namespaces 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, labels.<key> for map field, or attributes.<field> for attributes 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:

    • labels.owner returns namespaces that have a label with the key owner, this is the same as labels:owner
    • labels.owner=sd returns namespaces that have key/value owner=sd
    • name>projects/my-project/locations/us-east1/namespaces/namespace-c returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not
    • labels.owner!=sd AND labels.foo=bar returns namespaces 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 namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results
    • attributes.managed_registration=true returns namespaces that are managed by a GCP product or service

    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 project and location whose namespaces you'd like to list.

#parent=

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