Class: Google::Cloud::Dataplex::V1::ListGlossaryCategoriesRequest

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

Overview

List GlossaryCategories Request

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

  • immediate_parent

Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

This will only return the GlossaryCategories that are directly nested under the specified parent.

Returns:

  • (::String) —

    Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:

    • immediate_parent

    Examples of using a filter are: - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" - immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"

    This will only return the GlossaryCategories that are directly nested under the specified parent.



394
395
396
397
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 394

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

#order_by ⇒ ::String

Returns Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

Returns:

  • (::String) —

    Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.



394
395
396
397
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 394

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

#page_size ⇒ ::Integer

Returns Optional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns:

  • (::Integer) —

    Optional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.



394
395
396
397
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 394

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

#page_token ⇒ ::String

Returns Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.

Returns:

  • (::String) —

    Optional. A page token, received from a previous ListGlossaryCategories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaryCategories must match the call that provided the page token.



394
395
396
397
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 394

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

#parent ⇒ ::String

Returns Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.

Returns:

  • (::String) —

    Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.



394
395
396
397
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 394

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