Google Cloud Dataplex V1 Client - Class MetadataFeed (1.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class MetadataFeed.

MetadataFeed contains information related to the metadata feed.

Generated from protobuf message google.cloud.dataplex.v1.MetadataFeed

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ 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}.

↳ 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 MetadataFeed\Scope

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

↳ filters MetadataFeed\Filters

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

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the feed was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The time when the feed was updated.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels.

↳ pubsub_topic 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.

getName

Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.

Returns
Type Description
string

setName

Identifier. The resource name of the metadata feed, in the format projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

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.

Returns
Type Description
string

setUid

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getScope

Required. The scope of the metadata feed.

Only the in scope changes are published.

Returns
Type Description
MetadataFeed\Scope|null

hasScope

clearScope

setScope

Required. The scope of the metadata feed.

Only the in scope changes are published.

Parameter
Name Description
var MetadataFeed\Scope
Returns
Type Description
$this

getFilters

Optional. The filters of the metadata feed.

Only the changes that match the filters are published.

Returns
Type Description
MetadataFeed\Filters|null

hasFilters

clearFilters

setFilters

Optional. The filters of the metadata feed.

Only the changes that match the filters are published.

Parameter
Name Description
var MetadataFeed\Filters
Returns
Type Description
$this

getCreateTime

Output only. The time when the feed was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the feed was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time when the feed was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the feed was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Optional. User-defined labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getPubsubTopic

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.

Returns
Type Description
string

hasPubsubTopic

setPubsubTopic

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEndpoint

Returns
Type Description
string