# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ListGlossaryTermsRequest (v2.10.0)

2.10.0 (latest) 2.9.0 2.8.1 2.7.0 2.6.1 2.5.0 2.4.1 2.3.1 2.2.0 2.1.0 2.0.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.23.0 0.22.0 0.21.1 0.20.0 0.19.0 0.18.2 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.1 0.9.0 0.8.0 0.7.0 0.6.1 0.5.1 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ListGlossaryTermsRequest.

List GlossaryTerms Request

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #filter

    def filter() -> ::String

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

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::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.
**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.

### #order_by

    def order_by() -> ::String

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

### #order_by=

    def order_by=(value) -> ::String

**Parameter**

- **value** (::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.
**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.

### #page_size

    def page_size() -> ::Integer

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

### #page_size=

    def page_size=(value) -> ::Integer

**Parameter**

- **value** (::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.

### #page_token

    def page_token() -> ::String

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

### #page_token=

    def page_token=(value) -> ::String

**Parameter**

- **value** (::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.
**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.

### #parent

    def parent() -> ::String

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

### #parent=

    def parent=(value) -> ::String

**Parameter**

- **value** (::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.
**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.