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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

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

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

The standard list filter.

Generated from protobuf field string filter = 2;

Returns
TypeDescription
string

setFilter

The standard list filter.

Generated from protobuf field string filter = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

Generated from protobuf field int32 page_size = 3;

Returns
TypeDescription
int

setPageSize

The standard list page size.

Generated from protobuf field int32 page_size = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The standard list page token.

Generated from protobuf field string page_token = 4;

Returns
TypeDescription
string

setPageToken

The standard list page token.

Generated from protobuf field string page_token = 4;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;

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.

Generated from protobuf field string order_by = 6;

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.

Generated from protobuf field string order_by = 6;

Parameter
NameDescription
var string
Returns
TypeDescription
$this