Google Cloud Dataplex V1 Client - Class Scope (1.12.0)

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

Scope defines the scope of the metadata feed.

Scopes are exclusive. Only one of the scopes can be specified.

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

Namespace

Google \ Cloud \ Dataplex \ V1 \ MetadataFeed

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ organization_level bool

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}.
↳ entry_groups string[]

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

getOrganizationLevel

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.
Returns
Type Description
bool

setOrganizationLevel

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.
Parameter
Name Description
var bool
Returns
Type Description
$this

getProjects

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

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setProjects

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEntryGroups

Optional. The entry groups whose entries you want to listen to.

Must be in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setEntryGroups

Optional. The entry groups whose entries you want to listen to.

Must be in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.

Parameter
Name Description
var string[]
Returns
Type Description
$this