Class: Google::Cloud::Dataplex::V1::ListGlossaryTermsRequest

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 GlossaryTerms Request

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. Filter expression that filters GlossaryTerms 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 GlossaryTerms that are directly nested under the specified parent.

Returns:

  • (::String) —

    Optional. Filter expression that filters GlossaryTerms 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 GlossaryTerms that are directly nested under the specified parent.



508
509
510
511
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 508

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

#order_by ⇒ ::String

Returns Optional. Order by expression that orders GlossaryTerms 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 GlossaryTerms listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.



508
509
510
511
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 508

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

#page_size ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



508
509
510
511
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 508

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

#page_token ⇒ ::String

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

Returns:

  • (::String) —

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



508
509
510
511
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 508

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

#parent ⇒ ::String

Returns Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.

Returns:

  • (::String) —

    Required. The parent, which has this collection of GlossaryTerms. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.



508
509
510
511
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 508

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