Cloud Dataplex API . projects . locations . entryGroups . entryLinks

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, entryLinkId=None, x__xgafv=None)

Creates an Entry Link.

delete(name, x__xgafv=None)

Deletes an Entry Link.

get(name, x__xgafv=None)

Gets an Entry Link.

patch(name, allowMissing=None, aspectKeys=None, body=None, x__xgafv=None)

Updates an Entry Link.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, entryLinkId=None, x__xgafv=None)
Creates an Entry Link.

Args:
  parent: string, Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # EntryLink represents a link between two Entries.
  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
    "a_key": { # An aspect is a single piece of metadata describing an entry.
      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
        "createTime": "A String", # The time the aspect was created in the source system.
        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
        "updateTime": "A String", # The time the aspect was last updated in the source system.
      },
      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
      "createTime": "A String", # Output only. The time when the Aspect was created.
      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
        "a_key": "", # Properties of the object.
      },
      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
    },
  },
  "createTime": "A String", # Output only. The time when the Entry Link was created.
  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    { # Reference to the Entry that is linked through the Entry Link.
      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
      "type": "A String", # Required. Immutable. The reference type of the Entry.
    },
  ],
  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
}

  entryLinkId: string, Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EntryLink represents a link between two Entries.
  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
    "a_key": { # An aspect is a single piece of metadata describing an entry.
      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
        "createTime": "A String", # The time the aspect was created in the source system.
        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
        "updateTime": "A String", # The time the aspect was last updated in the source system.
      },
      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
      "createTime": "A String", # Output only. The time when the Aspect was created.
      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
        "a_key": "", # Properties of the object.
      },
      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
    },
  },
  "createTime": "A String", # Output only. The time when the Entry Link was created.
  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    { # Reference to the Entry that is linked through the Entry Link.
      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
      "type": "A String", # Required. Immutable. The reference type of the Entry.
    },
  ],
  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
}
delete(name, x__xgafv=None)
Deletes an Entry Link.

Args:
  name: string, Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EntryLink represents a link between two Entries.
  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
    "a_key": { # An aspect is a single piece of metadata describing an entry.
      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
        "createTime": "A String", # The time the aspect was created in the source system.
        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
        "updateTime": "A String", # The time the aspect was last updated in the source system.
      },
      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
      "createTime": "A String", # Output only. The time when the Aspect was created.
      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
        "a_key": "", # Properties of the object.
      },
      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
    },
  },
  "createTime": "A String", # Output only. The time when the Entry Link was created.
  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    { # Reference to the Entry that is linked through the Entry Link.
      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
      "type": "A String", # Required. Immutable. The reference type of the Entry.
    },
  ],
  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
}
get(name, x__xgafv=None)
Gets an Entry Link.

Args:
  name: string, Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EntryLink represents a link between two Entries.
  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
    "a_key": { # An aspect is a single piece of metadata describing an entry.
      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
        "createTime": "A String", # The time the aspect was created in the source system.
        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
        "updateTime": "A String", # The time the aspect was last updated in the source system.
      },
      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
      "createTime": "A String", # Output only. The time when the Aspect was created.
      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
        "a_key": "", # Properties of the object.
      },
      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
    },
  },
  "createTime": "A String", # Output only. The time when the Entry Link was created.
  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    { # Reference to the Entry that is linked through the Entry Link.
      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
      "type": "A String", # Required. Immutable. The reference type of the Entry.
    },
  ],
  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
}
patch(name, allowMissing=None, aspectKeys=None, body=None, x__xgafv=None)
Updates an Entry Link.

Args:
  name: string, Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # EntryLink represents a link between two Entries.
  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
    "a_key": { # An aspect is a single piece of metadata describing an entry.
      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
        "createTime": "A String", # The time the aspect was created in the source system.
        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
        "updateTime": "A String", # The time the aspect was last updated in the source system.
      },
      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
      "createTime": "A String", # Output only. The time when the Aspect was created.
      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
        "a_key": "", # Properties of the object.
      },
      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
    },
  },
  "createTime": "A String", # Output only. The time when the Entry Link was created.
  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    { # Reference to the Entry that is linked through the Entry Link.
      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
      "type": "A String", # Required. Immutable. The reference type of the Entry.
    },
  ],
  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
}

  allowMissing: boolean, Optional. If set to true and the entry link doesn't exist, the service will create it.
  aspectKeys: string, Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # EntryLink represents a link between two Entries.
  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
    "a_key": { # An aspect is a single piece of metadata describing an entry.
      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
        "createTime": "A String", # The time the aspect was created in the source system.
        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
        "updateTime": "A String", # The time the aspect was last updated in the source system.
      },
      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
      "createTime": "A String", # Output only. The time when the Aspect was created.
      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
        "a_key": "", # Properties of the object.
      },
      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
    },
  },
  "createTime": "A String", # Output only. The time when the Entry Link was created.
  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
    { # Reference to the Entry that is linked through the Entry Link.
      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
      "type": "A String", # Required. Immutable. The reference type of the Entry.
    },
  ],
  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
}