REST Resource: projects.locations.metadataFeeds

Resource: MetadataFeed

MetadataFeed contains information related to the metadata feed.

JSON representation 
{
  "name": string,
  "uid": string,
  "scope": {
    object (Scope)
  },
  "filters": {
    object (Filters)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}
Fields
name

string

Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{locationId}/metadataFeeds/{metadataFeedId}.
uid

string

Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
scope

object (Scope)

Required. The scope of the metadata feed. Only the in scope changes are published.
filters

object (Filters)

Optional. The filters of the metadata feed. Only the changes that match the filters are published.
createTime

string (Timestamp format)

Output only. The time when the feed was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time when the feed was updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. User-defined labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union field endpoint. The endpoint defines the where the metadata feed messages are published. endpoint can be only one of the following:
pubsubTopic

string

Optional. The pubsub topic that you want the metadata feed messages to publish to. Please grant Dataplex service account the permission to publish messages to the topic. The service account is: service-{PROJECT_NUMBER}@gcp-sa-dataplex.iam.gserviceaccount.com.

Scope

Scope defines the scope of the metadata feed. Scopes are exclusive. Only one of the scopes can be specified.

JSON representation 
{
  "organizationLevel": boolean,
  "projects": [
    string
  ],
  "entryGroups": [
    string
  ]
}
Fields
organizationLevel

boolean

Optional. Whether the metadata feed is at the organization-level.

  • If true, all changes happened to the entries in the same organization as the feed are published.
  • If false, you must specify a list of projects or a list of entry groups whose entries you want to listen to.

The default is false.
projects[]

string

Optional. The projects whose entries you want to listen to. Must be in the same organization as the feed. Must be in the format: projects/{project_id_or_number}.
entryGroups[]

string

Optional. The entry groups whose entries you want to listen to. Must be in the format: projects/{project_id_or_number}/locations/{locationId}/entryGroups/{entryGroupId}.

Filters

Filters defines the type of changes that you want to listen to. You can have multiple entry type filters and multiple aspect type filters. All of the entry type filters are OR'ed together. All of the aspect type filters are OR'ed together. All of the entry type filters and aspect type filters are AND'ed together.

JSON representation 
{
  "entryTypes": [
    string
  ],
  "aspectTypes": [
    string
  ],
  "changeTypes": [
    enum (ChangeType)
  ]
}
Fields
entryTypes[]

string

Optional. The entry types that you want to listen to, specified as relative resource names in the format projects/{project_id_or_number}/locations/{location}/entryTypes/{entryTypeId}. Only entries that belong to the specified entry types are published.
aspectTypes[]

string

Optional. The aspect types that you want to listen to. Depending on how the aspect is attached to the entry, in the format: projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspectTypeId}.
changeTypes[]

enum (ChangeType)

Optional. The type of change that you want to listen to. If not specified, all changes are published.

ChangeType

The type of change that you want to listen to.

Enums
CHANGE_TYPE_UNSPECIFIED Unspecified change type. Defaults to UNSPECIFIED.
CREATE The change is a create event.
UPDATE The change is an update event.
DELETE The change is a delete event.

Methods

create

 Creates a MetadataFeed.

delete

 Deletes a MetadataFeed.

get

 Gets a MetadataFeed.

list

 Retrieve a list of MetadataFeeds.

patch

 Updates a MetadataFeed.