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
NameDescription
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
TypeDescription
string

setParent

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

Returns
TypeDescription
int

setPageSize

The standard list page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The standard list page token.

Returns
TypeDescription
string

setPageToken

The standard list page token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\AIPlatform\V1\ListDatasetsRequest