Class MetadataFeed.Scope.Builder (1.86.0)

public static final class MetadataFeed.Scope.Builder extends GeneratedMessage.Builder<MetadataFeed.Scope.Builder> implements MetadataFeed.ScopeOrBuilder

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

Protobuf type google.cloud.dataplex.v1.MetadataFeed.Scope

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllEntryGroups(Iterable<String> values)

public MetadataFeed.Scope.Builder addAllEntryGroups(Iterable<String> values)

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The entryGroups to add.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

addAllProjects(Iterable<String> values)

public MetadataFeed.Scope.Builder addAllProjects(Iterable<String> values)

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The projects to add.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

addEntryGroups(String value)

public MetadataFeed.Scope.Builder addEntryGroups(String value)

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The entryGroups to add.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

addEntryGroupsBytes(ByteString value)

public MetadataFeed.Scope.Builder addEntryGroupsBytes(ByteString value)

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the entryGroups to add.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

addProjects(String value)

public MetadataFeed.Scope.Builder addProjects(String value)

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The projects to add.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

addProjectsBytes(ByteString value)

public MetadataFeed.Scope.Builder addProjectsBytes(ByteString value)

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the projects to add.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

build()

public MetadataFeed.Scope build()
Returns
Type Description
MetadataFeed.Scope

buildPartial()

public MetadataFeed.Scope buildPartial()
Returns
Type Description
MetadataFeed.Scope

clear()

public MetadataFeed.Scope.Builder clear()
Returns
Type Description
MetadataFeed.Scope.Builder
Overrides

clearEntryGroups()

public MetadataFeed.Scope.Builder clearEntryGroups()

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

clearOrganizationLevel()

public MetadataFeed.Scope.Builder clearOrganizationLevel()

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.

bool organization_level = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

clearProjects()

public MetadataFeed.Scope.Builder clearProjects()

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

getDefaultInstanceForType()

public MetadataFeed.Scope getDefaultInstanceForType()
Returns
Type Description
MetadataFeed.Scope

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntryGroups(int index)

public String getEntryGroups(int index)

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The entryGroups at the given index.

getEntryGroupsBytes(int index)

public ByteString getEntryGroupsBytes(int index)

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the entryGroups at the given index.

getEntryGroupsCount()

public int getEntryGroupsCount()

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of entryGroups.

getEntryGroupsList()

public ProtocolStringList getEntryGroupsList()

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the entryGroups.

getOrganizationLevel()

public boolean 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.

bool organization_level = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The organizationLevel.

getProjects(int index)

public String getProjects(int index)

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The projects at the given index.

getProjectsBytes(int index)

public ByteString getProjectsBytes(int index)

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the projects at the given index.

getProjectsCount()

public int getProjectsCount()

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of projects.

getProjectsList()

public ProtocolStringList getProjectsList()

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the projects.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetadataFeed.Scope other)

public MetadataFeed.Scope.Builder mergeFrom(MetadataFeed.Scope other)
Parameter
Name Description
other MetadataFeed.Scope
Returns
Type Description
MetadataFeed.Scope.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetadataFeed.Scope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MetadataFeed.Scope.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MetadataFeed.Scope.Builder
Overrides

setEntryGroups(int index, String value)

public MetadataFeed.Scope.Builder setEntryGroups(int index, String value)

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

repeated string entry_groups = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The entryGroups to set.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

setOrganizationLevel(boolean value)

public MetadataFeed.Scope.Builder setOrganizationLevel(boolean value)

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.

bool organization_level = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The organizationLevel to set.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.

setProjects(int index, String value)

public MetadataFeed.Scope.Builder setProjects(int index, String value)

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

repeated string projects = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The projects to set.

Returns
Type Description
MetadataFeed.Scope.Builder

This builder for chaining.