Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListPartitionsRequest.
List metadata partitions request.
Generated from protobuf message google.cloud.dataplex.v1.ListPartitionsRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}
.
↳ page_size
int
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
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.
↳ filter
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.
getParent
Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}
.
string
setParent
Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}
.
var
string
$this
getPageSize
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.
int
setPageSize
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.
var
int
$this
getPageToken
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.
string
setPageToken
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.
var
string
$this
getFilter
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.
string
setFilter
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.
var
string
$this
static::build
parent
string
Required. The resource name of the parent entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}
. Please see Google\Cloud\Dataplex\V1\MetadataServiceClient::entityName()
for help formatting this field.