# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ListDataProductsRequest (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::ListDataProductsRequest.

Request message for listing data products.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #filter

    def filter() -> ::String

**Returns**

- (::String) --- Optional. Filter expression that filters data products listed in the response.

  Example of using this filter is: `display_name="my-data-product"`

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Filter expression that filters data products listed in the response.


  Example of using this filter is: `display_name="my-data-product"`
**Returns**

- (::String) --- Optional. Filter expression that filters data products listed in the response.

  Example of using this filter is: `display_name="my-data-product"`

### #order_by

    def order_by() -> ::String

**Returns**

- (::String) --- Optional. Order by expression that orders data products listed in the response.

  Supported Order by fields are: `name` or `create_time`.

  If not specified, the ordering is undefined.

  Ordering by `create_time` is not supported when listing resources across
  locations (i.e. when request contains `/locations/-`).

### #order_by=

    def order_by=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Order by expression that orders data products listed in the response.


  Supported Order by fields are: `name` or `create_time`.

  If not specified, the ordering is undefined.

  Ordering by `create_time` is not supported when listing resources across
  locations (i.e. when request contains `/locations/-`).
**Returns**

- (::String) --- Optional. Order by expression that orders data products listed in the response.

  Supported Order by fields are: `name` or `create_time`.

  If not specified, the ordering is undefined.

  Ordering by `create_time` is not supported when listing resources across
  locations (i.e. when request contains `/locations/-`).

### #page_size

    def page_size() -> ::Integer

**Returns**

- (::Integer) --- Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products 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 data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
**Returns**

- (::Integer) --- Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products 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 `ListDataProducts` call. Provide this to retrieve the subsequent page.


  When paginating, all other parameters provided to `ListDataProducts` 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 `ListDataProducts` call. Provide this to retrieve the subsequent page.


  When paginating, all other parameters provided to `ListDataProducts` must
  match the call that provided the page token.
**Returns**

- (::String) --- Optional. A page token, received from a previous `ListDataProducts` call. Provide this to retrieve the subsequent page.


  When paginating, all other parameters provided to `ListDataProducts` must
  match the call that provided the page token.

### #parent

    def parent() -> ::String

**Returns**

- (::String) --- Required. The parent, which has this collection of data products.

  Format: `projects/{project_id_or_number}/locations/{location_id}`.

  Supports listing across all locations with the wildcard `-` (hyphen)
  character. Example: `projects/{project_id_or_number}/locations/-`

### #parent=

    def parent=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The parent, which has this collection of data products.


  Format: `projects/{project_id_or_number}/locations/{location_id}`.

  Supports listing across all locations with the wildcard `-` (hyphen)
  character. Example: `projects/{project_id_or_number}/locations/-`
**Returns**

- (::String) --- Required. The parent, which has this collection of data products.

  Format: `projects/{project_id_or_number}/locations/{location_id}`.

  Supports listing across all locations with the wildcard `-` (hyphen)
  character. Example: `projects/{project_id_or_number}/locations/-`