Google Cloud Ai Platform V1 Client - Class DataItem (0.18.0)

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

A piece of data in a Dataset. Could be an image, a video, a document or plain text.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the DataItem.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this DataItem was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this DataItem was last updated.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels with user-defined metadata to organize your DataItems. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

↳ payload Google\Protobuf\Value

Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field.

↳ etag string

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

getName

Output only. The resource name of the DataItem.

Returns
TypeDescription
string

setName

Output only. The resource name of the DataItem.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp when this DataItem was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this DataItem was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Timestamp when this DataItem was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this DataItem was last updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Optional. The labels with user-defined metadata to organize your DataItems.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels with user-defined metadata to organize your DataItems.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getPayload

Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field.

Returns
TypeDescription
Google\Protobuf\Value|null

hasPayload

clearPayload

setPayload

Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field.

Parameter
NameDescription
var Google\Protobuf\Value
Returns
TypeDescription
$this

getEtag

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
TypeDescription
string

setEtag

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
NameDescription
var string
Returns
TypeDescription
$this