Google Cloud Ai Platform V1 Client - Class ListAnnotationsRequest (0.37.1)

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

Request message for DatasetService.ListAnnotations.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

↳ filter string

The standard list filter.

↳ 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.

getParent

Required. The resource name of the DataItem to list Annotations from.

Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

Returns
Type Description
string

setParent

Required. The resource name of the DataItem to list Annotations from.

Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

The standard list filter.

Returns
Type Description
string

setFilter

The standard list filter.

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item} Please see Google\Cloud\AIPlatform\V1\DatasetServiceClient::dataItemName() for help formatting this field.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ListAnnotationsRequest