Class MetadataFeed.Scope (1.86.0)

public static final class MetadataFeed.Scope extends GeneratedMessage 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 Fields

ENTRY_GROUPS_FIELD_NUMBER

public static final int ENTRY_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

ORGANIZATION_LEVEL_FIELD_NUMBER

public static final int ORGANIZATION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

PROJECTS_FIELD_NUMBER

public static final int PROJECTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetadataFeed.Scope getDefaultInstance()
Returns
Type Description
MetadataFeed.Scope

getDescriptor()

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

newBuilder()

public static MetadataFeed.Scope.Builder newBuilder()
Returns
Type Description
MetadataFeed.Scope.Builder

newBuilder(MetadataFeed.Scope prototype)

public static MetadataFeed.Scope.Builder newBuilder(MetadataFeed.Scope prototype)
Parameter
Name Description
prototype MetadataFeed.Scope
Returns
Type Description
MetadataFeed.Scope.Builder

parseDelimitedFrom(InputStream input)

public static MetadataFeed.Scope parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataFeed.Scope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetadataFeed.Scope parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetadataFeed.Scope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetadataFeed.Scope parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetadataFeed.Scope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetadataFeed.Scope parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataFeed.Scope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetadataFeed.Scope parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataFeed.Scope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetadataFeed.Scope parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetadataFeed.Scope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataFeed.Scope
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetadataFeed.Scope> parser()
Returns
Type Description
Parser<Scope>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<MetadataFeed.Scope> getParserForType()
Returns
Type Description
Parser<Scope>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetadataFeed.Scope.Builder newBuilderForType()
Returns
Type Description
MetadataFeed.Scope.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected MetadataFeed.Scope.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetadataFeed.Scope.Builder
Overrides

toBuilder()

public MetadataFeed.Scope.Builder toBuilder()
Returns
Type Description
MetadataFeed.Scope.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException