Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ListPartitionsRequest.
List metadata partitions request.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) —
Optional. Filter the partitions returned to the caller using a key value
pair expression. Supported operators and syntax:
logic operators: AND, OR
comparison operators: <, >, >=, <= ,=, !=
LIKE operators:
The right hand of a LIKE operator supports "." and
"" for wildcard searches, for example "value1 LIKE ".*oo."
parenthetical grouping: ( )
Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
Notes:
Keys to the left of operators are case insensitive.
Partition results are sorted first by creation time, then by
lexicographic order.
Up to 20 key value filter pairs are allowed, but due to performance
considerations, only the first 10 will be used as a filter.
#filter=
deffilter=(value)->::String
Parameter
value (::String) —
Optional. Filter the partitions returned to the caller using a key value
pair expression. Supported operators and syntax:
logic operators: AND, OR
comparison operators: <, >, >=, <= ,=, !=
LIKE operators:
The right hand of a LIKE operator supports "." and
"" for wildcard searches, for example "value1 LIKE ".*oo."
parenthetical grouping: ( )
Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
Notes:
Keys to the left of operators are case insensitive.
Partition results are sorted first by creation time, then by
lexicographic order.
Up to 20 key value filter pairs are allowed, but due to performance
considerations, only the first 10 will be used as a filter.
Returns
(::String) —
Optional. Filter the partitions returned to the caller using a key value
pair expression. Supported operators and syntax:
logic operators: AND, OR
comparison operators: <, >, >=, <= ,=, !=
LIKE operators:
The right hand of a LIKE operator supports "." and
"" for wildcard searches, for example "value1 LIKE ".*oo."
parenthetical grouping: ( )
Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
Notes:
Keys to the left of operators are case insensitive.
Partition results are sorted first by creation time, then by
lexicographic order.
Up to 20 key value filter pairs are allowed, but due to performance
considerations, only the first 10 will be used as a filter.
#page_size
defpage_size()->::Integer
Returns
(::Integer) — Optional. Maximum number of partitions to return. The service may return
fewer than this value. If unspecified, 100 partitions will be returned by
default. The maximum page size is 500; larger values will will be truncated
to 500.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — Optional. Maximum number of partitions to return. The service may return
fewer than this value. If unspecified, 100 partitions will be returned by
default. The maximum page size is 500; larger values will will be truncated
to 500.
Returns
(::Integer) — Optional. Maximum number of partitions to return. The service may return
fewer than this value. If unspecified, 100 partitions will be returned by
default. The maximum page size is 500; larger values will will be truncated
to 500.
#page_token
defpage_token()->::String
Returns
(::String) — Optional. Page token received from a previous ListPartitions call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListPartitions must match the call that provided
the page token.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — Optional. Page token received from a previous ListPartitions call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListPartitions must match the call that provided
the page token.
Returns
(::String) — Optional. Page token received from a previous ListPartitions call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListPartitions must match the call that provided
the page token.
#parent
defparent()->::String
Returns
(::String) — Required. The resource name of the parent entity:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The resource name of the parent entity:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
Returns
(::String) — Required. The resource name of the parent entity:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ListPartitionsRequest (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-ListPartitionsRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-ListPartitionsRequest) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ListPartitionsRequest.\n\nList metadata partitions request. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Filter the partitions returned to the caller using a key value\n pair expression. Supported operators and syntax:\n\n - logic operators: AND, OR\n - comparison operators: \\\u003c, \\\u003e, \\\u003e=, \\\u003c= ,=, !=\n - LIKE operators:\n - The right hand of a LIKE operator supports \".\" and \"*\" for wildcard searches, for example \"value1 LIKE \".\\*oo.*\"\n - parenthetical grouping: ( )\n\n Sample filter expression: \\`?filter=\"key1 \\\u003c value1 OR key2 \\\u003e value2\"\n\n **Notes:**\n - Keys to the left of operators are case insensitive.\n - Partition results are sorted first by creation time, then by lexicographic order.\n - Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Optional. Filter the partitions returned to the caller using a key value\n pair expression. Supported operators and syntax:\n - logic operators: AND, OR\n - comparison operators: \\\u003c, \\\u003e, \\\u003e=, \\\u003c= ,=, !=\n - LIKE operators:\n - The right hand of a LIKE operator supports \".\" and \"*\" for wildcard searches, for example \"value1 LIKE \".\\*oo.*\"\n - parenthetical grouping: ( )\n\n Sample filter expression: \\`?filter=\"key1 \\\u003c value1 OR key2 \\\u003e value2\"\n\n **Notes:**\n - Keys to the left of operators are case insensitive.\n - Partition results are sorted first by creation time, then by lexicographic order.\n- Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter. \n**Returns**\n\n- (::String) --- Optional. Filter the partitions returned to the caller using a key value\n pair expression. Supported operators and syntax:\n\n - logic operators: AND, OR\n - comparison operators: \\\u003c, \\\u003e, \\\u003e=, \\\u003c= ,=, !=\n - LIKE operators:\n - The right hand of a LIKE operator supports \".\" and \"*\" for wildcard searches, for example \"value1 LIKE \".\\*oo.*\"\n - parenthetical grouping: ( )\n\n Sample filter expression: \\`?filter=\"key1 \\\u003c value1 OR key2 \\\u003e value2\"\n\n **Notes:**\n - Keys to the left of operators are case insensitive.\n - Partition results are sorted first by creation time, then by lexicographic order.\n - Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500. \n**Returns**\n\n- (::Integer) --- Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Page token received from a previous `ListPartitions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitions` must match the call that provided the page token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Page token received from a previous `ListPartitions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitions` must match the call that provided the page token. \n**Returns**\n\n- (::String) --- Optional. Page token received from a previous `ListPartitions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitions` must match the call that provided the page token.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The resource name of the parent entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The resource name of the parent entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. \n**Returns**\n\n- (::String) --- Required. The resource name of the parent entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`."]]