Google Cloud Ai Platform V1 Client - Class ListDatasetsRequest (0.25.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListDatasetsRequest.

Request message for DatasetService.ListDatasets.

Generated from protobuf message google.cloud.aiplatform.v1.ListDatasetsRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
`↳ filter`	`string` An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted.`labels."a key"`. Some examples: `displayName="myDisplayName"``labels.myKey="myValue"`
`↳ page_size`	`int` The standard list page size.
`↳ page_token`	`string` The standard list page token.
`↳ read_mask`	`Google\Protobuf\FieldMask` Mask specifying which fields to read.
`↳ order_by`	`string` A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`

getParent

Required. The name of the Dataset's parent resource.

Format: projects/{project}/locations/{location}

Returns
Type	Description
`string`

setParent

Required. The name of the Dataset's parent resource.

Format: projects/{project}/locations/{location}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

display_name: supports = and !=
- metadata_schema_uri: supports = and !=
- labels supports general map functions that is:
  - labels.key=value - key:value equality
  - `labels.key:* or labels:key - key existence
  - A key including a space must be quoted. labels."a key". Some examples:
- displayName="myDisplayName"
- labels.myKey="myValue"

Returns
Type	Description
`string`

setFilter

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

display_name: supports = and !=
- metadata_schema_uri: supports = and !=
- labels supports general map functions that is:
  - labels.key=value - key:value equality
  - `labels.key:* or labels:key - key existence
  - A key including a space must be quoted. labels."a key". Some examples:
- displayName="myDisplayName"
- labels.myKey="myValue"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The standard list page size.

Returns
Type	Description
`int`

setPageSize

The standard list page size.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

The standard list page token.

Returns
Type	Description
`string`

setPageToken

The standard list page token.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReadMask

Mask specifying which fields to read.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending. Supported fields:

display_name
create_time
update_time

Returns
Type	Description
`string`

setOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending. Supported fields:

display_name
create_time
update_time

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}` Please see Google\Cloud\AIPlatform\V1\DatasetServiceClient::locationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ListDatasetsRequest`