REST Resource: projects.locations.entryGroups.entries

Resource: Entry

An entry is a representation of a data resource that can be described by various metadata.

JSON representation 
{
  "name": string,
  "entryType": string,
  "createTime": string,
  "updateTime": string,
  "aspects": {
    string: {
      object (Aspect)
    },
    ...
  },
  "parentEntry": string,
  "fullyQualifiedName": string,
  "entrySource": {
    object (EntrySource)
  }
}
Fields
name

string

Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{locationId}/entryGroups/{entryGroupId}/entries/{entryId}.
entryType

string

Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{locationId}/entryTypes/{entryTypeId}.
createTime

string (Timestamp format)

Output only. The time when the entry was created in Dataplex.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the entry was last updated in Dataplex.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
aspects

map (key: string, value: object (Aspect))

Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following:

  • If the aspect is attached directly to the entry: {project_id_or_number}.{locationId}.{aspectTypeId}
  • If the aspect is attached to an entry's path: {project_id_or_number}.{locationId}.{aspectTypeId}@{path}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
parentEntry

string

Optional. Immutable. The resource name of the parent entry.
fullyQualifiedName

string

Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names. The maximum size of the field is 4000 characters.
entrySource

object (EntrySource)

Optional. Information related to the source system of the data resource that is represented by the entry.

Aspect

An aspect is a single piece of metadata describing an entry.

JSON representation 
{
  "aspectType": string,
  "path": string,
  "createTime": string,
  "updateTime": string,
  "data": {
    object
  },
  "aspectSource": {
    object (AspectSource)
  }
}
Fields
aspectType

string

Output only. The resource name of the type used to create this Aspect.
path

string

Output only. The path in the entry under which the aspect is attached.
createTime

string (Timestamp format)

Output only. The time when the Aspect was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the Aspect was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
data

object (Struct format)

Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
aspectSource

object (AspectSource)

Optional. Information related to the source system of the aspect.

AspectSource

Information related to the source system of the aspect.

JSON representation 
{
  "createTime": string,
  "updateTime": string,
  "dataVersion": string
}
Fields
createTime

string (Timestamp format)

The time the aspect was created in the source system.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

The time the aspect was last updated in the source system.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
dataVersion

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).

EntrySource

Information related to the source system of the data resource that is represented by the entry.

JSON representation 
{
  "resource": string,
  "system": string,
  "platform": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "ancestors": [
    {
      object (Ancestor)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "location": string
}
Fields
resource

string

The name of the resource in the source system. Maximum length is 4,000 characters.
system

string

The name of the source system. Maximum length is 64 characters.
platform

string

The platform containing the source system. Maximum length is 64 characters.
displayName

string

A user-friendly display name. Maximum length is 500 characters.
description

string

A description of the data resource. Maximum length is 2,000 characters.
labels

map (key: string, value: string)

User-defined labels. The maximum size of keys and values is 128 characters each.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
ancestors[]

object (Ancestor)

Immutable. The entries representing the ancestors of the data resource in the source system.
createTime

string (Timestamp format)

The time when the resource was created in the source system.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has updateTime populated, further updates to the EntrySource of the entry must provide incremental updates to its updateTime.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
location

string

Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.

Ancestor

Information about individual items in the hierarchy that is associated with the data resource.

JSON representation 
{
  "name": string,
  "type": string
}
Fields
name

string

Optional. The name of the ancestor resource.
type

string

Optional. The type of the ancestor resource.

Methods

create

 Creates an Entry.

delete

 Deletes an Entry.

get

 Gets an Entry.

list

 Lists Entries within an EntryGroup.

patch

 Updates an Entry.