Console
    Start free

    Google Cloud Dataplex V1 Client - Class GlossaryTerm (1.11.0)

    Reference documentation and code samples for the Google Cloud Dataplex V1 Client class GlossaryTerm.

    GlossaryTerms are the core of Glossary.

    A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them.

    Generated from protobuf message google.cloud.dataplex.v1.GlossaryTerm

    Namespace

    Google \ Cloud \ Dataplex \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}

    ↳ uid
    string

    Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.

    ↳ display_name
    string

    Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.

    ↳ description
    string

    Optional. The user-mutable description of the GlossaryTerm.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The time at which the GlossaryTerm was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The time at which the GlossaryTerm was last updated.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Optional. User-defined labels for the GlossaryTerm.

    ↳ parent
    string

    Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}

    getName

    Output only. Identifier. The resource name of the GlossaryTerm.

    Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}

    Returns
    Type
    Description
    string

    setName

    Output only. Identifier. The resource name of the GlossaryTerm.

    Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getUid

    Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.

    Returns
    Type
    Description
    string

    setUid

    Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.

    Returns
    Type
    Description
    string

    setDisplayName

    Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. The user-mutable description of the GlossaryTerm.

    Returns
    Type
    Description
    string

    setDescription

    Optional. The user-mutable description of the GlossaryTerm.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The time at which the GlossaryTerm was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The time at which the GlossaryTerm was created.

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

    getUpdateTime

    Output only. The time at which the GlossaryTerm was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The time at which the GlossaryTerm was last updated.

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

    getLabels

    Optional. User-defined labels for the GlossaryTerm.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Optional. User-defined labels for the GlossaryTerm.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getParent

    Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory.

    Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}

    Returns
    Type
    Description
    string

    setParent

    Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory.

    Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: