Console
    Contact Us Start free

    Google Cloud Ai Platform V1 Client - Class Annotation (1.35.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

    Namespace

    Google \ Cloud \ AIPlatform \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    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
    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.

    Returns
    Type
    Description
    string

    setName

    Output only. Resource name of the Annotation.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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 .

    Returns
    Type
    Description
    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 .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPayload

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

    Returns
    Type
    Description
    Google\Protobuf\Value |null

    hasPayload

    clearPayload

    setPayload

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Value
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Timestamp when this Annotation was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Timestamp when this Annotation was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Timestamp when this Annotation was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Timestamp when this Annotation was last updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEtag

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

    Returns
    Type
    Description
    string

    setEtag

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAnnotationSource

    Output only. The source of the Annotation.

    Returns
    Type
    Description
    UserActionReference |null

    hasAnnotationSource

    clearAnnotationSource

    setAnnotationSource

    Output only. The source of the Annotation.

    Parameter
    Name
    Description
    var
    UserActionReference
    Returns
    Type
    Description
    $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.
    Returns
    Type
    Description
    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.
    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: