REST Resource: projects.locations.entryGroups.entries

Resource: Entry

An entry is a representation of a data asset which 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, of the form: projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}.

entryType

string

Required. Immutable. The resource name of the EntryType used to create this Entry.

createTime

string (Timestamp format)

Output only. The time when the Entry 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 Entry 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".

aspects

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

Optional. The Aspects attached to the Entry. The format for the key can be one of the following:

  1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry)
  2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's 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 reference it in an external system. The maximum size of the field is 4000 characters.

entrySource

object (EntrySource)

Optional. Information related to the source system for an 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)

AspectSource

AspectSource contains information related to the source system of the Aspect.

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

string (Timestamp format)

The create time of the aspect 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 update time of the aspect 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".

EntrySource

EntrySource contains information related to the source system of 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. The maximum size of the field is 4000 characters.

system

string

The name of the source system. The maximum size of the field is 64 characters.

platform

string

The platform containing the source system. The maximum size of the field is 64 characters.

displayName

string

User friendly display name. The maximum size of the field is 500 characters.

description

string

Description of the Entry. The maximum size of the field is 2000 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 ancestors of the Entry in the source system.

createTime

string (Timestamp format)

The create time of the resource 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 update time of the resource 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".

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 EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud.

Ancestor

Ancestor contains information about individual items in the hierarchy of an Entry.

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.