metadata_feeds

Creates, updates, deletes, gets or lists a metadata_feeds resource.

Overview

Name	metadata_feeds
Type	Resource
Id	google.dataplex.metadata_feeds

Fields

The following fields are returned by SELECT queries:

projects_locations_metadata_feeds_get

Name	Datatype	Description
name	string	Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.
createTime	string (google-datetime)	Output only. The time when the feed was created.
filters	object	Optional. The filters of the metadata feed. Only the changes that match the filters are published. (id: GoogleCloudDataplexV1MetadataFeedFilters)
labels	object	Optional. User-defined labels.
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	object	Required. The scope of the metadata feed. Only the in scope changes are published. (id: GoogleCloudDataplexV1MetadataFeedScope)
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.
updateTime	string (google-datetime)	Output only. The time when the feed was updated.

projects_locations_metadata_feeds_list

Name	Datatype	Description
name	string	Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.
createTime	string (google-datetime)	Output only. The time when the feed was created.
filters	object	Optional. The filters of the metadata feed. Only the changes that match the filters are published. (id: GoogleCloudDataplexV1MetadataFeedFilters)
labels	object	Optional. User-defined labels.
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	object	Required. The scope of the metadata feed. Only the in scope changes are published. (id: GoogleCloudDataplexV1MetadataFeedScope)
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.
updateTime	string (google-datetime)	Output only. The time when the feed was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_metadata_feeds_get	select	projectsId, locationsId, metadataFeedsId		Gets a MetadataFeed.
projects_locations_metadata_feeds_list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Retrieve a list of MetadataFeeds.
projects_locations_metadata_feeds_create	insert	projectsId, locationsId	metadataFeedId, validateOnly	Creates a MetadataFeed.
projects_locations_metadata_feeds_patch	update	projectsId, locationsId, metadataFeedsId	updateMask, validateOnly	Updates a MetadataFeed.
projects_locations_metadata_feeds_delete	delete	projectsId, locationsId, metadataFeedsId		Deletes a MetadataFeed.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
metadataFeedsId	string
projectsId	string
filter	string
metadataFeedId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_metadata_feeds_get

Gets a MetadataFeed.

SELECT
name,
createTime,
filters,
labels,
pubsubTopic,
scope,
uid,
updateTime
FROM google.dataplex.metadata_feeds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND metadataFeedsId = '{{ metadataFeedsId }}' -- required
;

projects_locations_metadata_feeds_list

Retrieve a list of MetadataFeeds.

SELECT
name,
createTime,
filters,
labels,
pubsubTopic,
scope,
uid,
updateTime
FROM google.dataplex.metadata_feeds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_metadata_feeds_create

Creates a MetadataFeed.

INSERT INTO google.dataplex.metadata_feeds (
data__filters,
data__labels,
data__name,
data__pubsubTopic,
data__scope,
projectsId,
locationsId,
metadataFeedId,
validateOnly
)
SELECT 
'{{ filters }}',
'{{ labels }}',
'{{ name }}',
'{{ pubsubTopic }}',
'{{ scope }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ metadataFeedId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: metadata_feeds
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the metadata_feeds resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the metadata_feeds resource.
  - name: filters
    description: |
      Optional. The filters of the metadata feed. Only the changes that match the filters are published.
    value:
      aspectTypes:
        - "{{ aspectTypes }}"
      changeTypes:
        - "{{ changeTypes }}"
      entryTypes:
        - "{{ entryTypes }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.
  - name: pubsubTopic
    value: "{{ pubsubTopic }}"
    description: |
      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.
  - name: scope
    description: |
      Required. The scope of the metadata feed. Only the in scope changes are published.
    value:
      entryGroups:
        - "{{ entryGroups }}"
      organizationLevel: {{ organizationLevel }}
      projects:
        - "{{ projects }}"
  - name: metadataFeedId
    value: "{{ metadataFeedId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

projects_locations_metadata_feeds_patch

Updates a MetadataFeed.

UPDATE google.dataplex.metadata_feeds
SET 
data__filters = '{{ filters }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__pubsubTopic = '{{ pubsubTopic }}',
data__scope = '{{ scope }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND metadataFeedsId = '{{ metadataFeedsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_metadata_feeds_delete

Deletes a MetadataFeed.

DELETE FROM google.dataplex.metadata_feeds
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND metadataFeedsId = '{{ metadataFeedsId }}' --required
;