Class MetadataFeed.Builder (1.86.0)

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

MetadataFeed contains information related to the metadata feed.

Protobuf type google.cloud.dataplex.v1.MetadataFeed

Static Methods

getDescriptor()

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

Methods

build()

public MetadataFeed build()
Returns
Type Description
MetadataFeed

buildPartial()

public MetadataFeed buildPartial()
Returns
Type Description
MetadataFeed

clear()

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

clearCreateTime()

public MetadataFeed.Builder clearCreateTime()

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MetadataFeed.Builder

clearEndpoint()

public MetadataFeed.Builder clearEndpoint()
Returns
Type Description
MetadataFeed.Builder

clearFilters()

public MetadataFeed.Builder clearFilters()

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataFeed.Builder

clearLabels()

public MetadataFeed.Builder clearLabels()
Returns
Type Description
MetadataFeed.Builder

clearName()

public MetadataFeed.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

clearPubsubTopic()

public MetadataFeed.Builder clearPubsubTopic()

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.

string pubsub_topic = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

clearScope()

public MetadataFeed.Builder clearScope()

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataFeed.Builder

clearUid()

public MetadataFeed.Builder clearUid()

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.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

clearUpdateTime()

public MetadataFeed.Builder clearUpdateTime()

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MetadataFeed.Builder

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public MetadataFeed getDefaultInstanceForType()
Returns
Type Description
MetadataFeed

getDescriptorForType()

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

getEndpointCase()

public MetadataFeed.EndpointCase getEndpointCase()
Returns
Type Description
MetadataFeed.EndpointCase

getFilters()

public MetadataFeed.Filters getFilters()

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataFeed.Filters

The filters.

getFiltersBuilder()

public MetadataFeed.Filters.Builder getFiltersBuilder()

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataFeed.Filters.Builder

getFiltersOrBuilder()

public MetadataFeed.FiltersOrBuilder getFiltersOrBuilder()

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataFeed.FiltersOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPubsubTopic()

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

string pubsub_topic = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pubsubTopic.

getPubsubTopicBytes()

public ByteString getPubsubTopicBytes()

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.

string pubsub_topic = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pubsubTopic.

getScope()

public MetadataFeed.Scope getScope()

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataFeed.Scope

The scope.

getScopeBuilder()

public MetadataFeed.Scope.Builder getScopeBuilder()

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataFeed.Scope.Builder

getScopeOrBuilder()

public MetadataFeed.ScopeOrBuilder getScopeOrBuilder()

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataFeed.ScopeOrBuilder

getUid()

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

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasFilters()

public boolean hasFilters()

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the filters field is set.

hasPubsubTopic()

public boolean hasPubsubTopic()

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.

string pubsub_topic = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pubsubTopic field is set.

hasScope()

public boolean hasScope()

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the scope field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public MetadataFeed.Builder mergeCreateTime(Timestamp value)

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
MetadataFeed.Builder

mergeFilters(MetadataFeed.Filters value)

public MetadataFeed.Builder mergeFilters(MetadataFeed.Filters value)

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetadataFeed.Filters
Returns
Type Description
MetadataFeed.Builder

mergeFrom(MetadataFeed other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeScope(MetadataFeed.Scope value)

public MetadataFeed.Builder mergeScope(MetadataFeed.Scope value)

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value MetadataFeed.Scope
Returns
Type Description
MetadataFeed.Builder

mergeUpdateTime(Timestamp value)

public MetadataFeed.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
MetadataFeed.Builder

putAllLabels(Map<String,String> values)

public MetadataFeed.Builder putAllLabels(Map<String,String> values)

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
MetadataFeed.Builder

putLabels(String key, String value)

public MetadataFeed.Builder putLabels(String key, String value)

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
MetadataFeed.Builder

removeLabels(String key)

public MetadataFeed.Builder removeLabels(String key)

Optional. User-defined labels.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
MetadataFeed.Builder

setCreateTime(Timestamp value)

public MetadataFeed.Builder setCreateTime(Timestamp value)

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
MetadataFeed.Builder

setCreateTime(Timestamp.Builder builderForValue)

public MetadataFeed.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the feed was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MetadataFeed.Builder

setFilters(MetadataFeed.Filters value)

public MetadataFeed.Builder setFilters(MetadataFeed.Filters value)

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetadataFeed.Filters
Returns
Type Description
MetadataFeed.Builder

setFilters(MetadataFeed.Filters.Builder builderForValue)

public MetadataFeed.Builder setFilters(MetadataFeed.Filters.Builder builderForValue)

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

.google.cloud.dataplex.v1.MetadataFeed.Filters filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MetadataFeed.Filters.Builder
Returns
Type Description
MetadataFeed.Builder

setName(String value)

public MetadataFeed.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

setNameBytes(ByteString value)

public MetadataFeed.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

setPubsubTopic(String value)

public MetadataFeed.Builder setPubsubTopic(String value)

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.

string pubsub_topic = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pubsubTopic to set.

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

setPubsubTopicBytes(ByteString value)

public MetadataFeed.Builder setPubsubTopicBytes(ByteString value)

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.

string pubsub_topic = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pubsubTopic to set.

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

setScope(MetadataFeed.Scope value)

public MetadataFeed.Builder setScope(MetadataFeed.Scope value)

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value MetadataFeed.Scope
Returns
Type Description
MetadataFeed.Builder

setScope(MetadataFeed.Scope.Builder builderForValue)

public MetadataFeed.Builder setScope(MetadataFeed.Scope.Builder builderForValue)

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

.google.cloud.dataplex.v1.MetadataFeed.Scope scope = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue MetadataFeed.Scope.Builder
Returns
Type Description
MetadataFeed.Builder

setUid(String value)

public MetadataFeed.Builder setUid(String value)

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.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

setUidBytes(ByteString value)

public MetadataFeed.Builder setUidBytes(ByteString value)

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.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
MetadataFeed.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public MetadataFeed.Builder setUpdateTime(Timestamp value)

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
MetadataFeed.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public MetadataFeed.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the feed was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MetadataFeed.Builder