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

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

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Resource name of the Annotation.

↳ payload_schema_uri string

Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata.

↳ payload Google\Protobuf\Value

Required. The schema of the payload can be found in payload_schema.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this Annotation was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this Annotation was last updated.

↳ etag string

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

↳ annotation_source Google\Cloud\AIPlatform\V1\UserActionReference

Output only. The source of the Annotation.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels with user-defined metadata to organize your Annotations. 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 Annotation(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. Following system labels exist for each Annotation: * "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI. * "aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

getName

Output only. Resource name of the Annotation.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setName

Output only. Resource name of the Annotation.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPayloadSchemaUri

Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an OpenAPI 3.0.2 Schema Object.

The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata.

Generated from protobuf field string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setPayloadSchemaUri

Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an OpenAPI 3.0.2 Schema Object.

The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata.

Generated from protobuf field string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPayload

Required. The schema of the payload can be found in payload_schema.

Generated from protobuf field .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Protobuf\Value|null

hasPayload

clearPayload

setPayload

Required. The schema of the payload can be found in payload_schema.

Generated from protobuf field .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];

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

getCreateTime

Output only. Timestamp when this Annotation was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this Annotation was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getUpdateTime

Output only. Timestamp when this Annotation was last updated.

Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this Annotation was last updated.

Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getEtag

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

Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setEtag

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

Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAnnotationSource

Output only. The source of the Annotation.

Generated from protobuf field .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\UserActionReference|null

hasAnnotationSource

clearAnnotationSource

setAnnotationSource

Output only. The source of the Annotation.

Generated from protobuf field .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\UserActionReference
Returns
TypeDescription
$this

getLabels

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

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 Annotation(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. Following system labels exist for each Annotation:

  • "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
  • "aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

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

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 Annotation(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. Following system labels exist for each Annotation:

  • "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.
  • "aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title.

Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

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