Class UsageSignal.Builder (1.26.0)

public static final class UsageSignal.Builder extends GeneratedMessageV3.Builder<UsageSignal.Builder> implements UsageSignalOrBuilder

The set of all usage signals that Data Catalog stores.

Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.

Protobuf type google.cloud.datacatalog.v1.UsageSignal

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UsageSignal.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UsageSignal.Builder
Overrides

build()

public UsageSignal build()
Returns
TypeDescription
UsageSignal

buildPartial()

public UsageSignal buildPartial()
Returns
TypeDescription
UsageSignal

clear()

public UsageSignal.Builder clear()
Returns
TypeDescription
UsageSignal.Builder
Overrides

clearCommonUsageWithinTimeRange()

public UsageSignal.Builder clearCommonUsageWithinTimeRange()
Returns
TypeDescription
UsageSignal.Builder

clearFavoriteCount()

public UsageSignal.Builder clearFavoriteCount()

Favorite count in the source system.

optional int64 favorite_count = 4;

Returns
TypeDescription
UsageSignal.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UsageSignal.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UsageSignal.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UsageSignal.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UsageSignal.Builder
Overrides

clearUpdateTime()

public UsageSignal.Builder clearUpdateTime()

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Returns
TypeDescription
UsageSignal.Builder

clearUsageWithinTimeRange()

public UsageSignal.Builder clearUsageWithinTimeRange()
Returns
TypeDescription
UsageSignal.Builder

clone()

public UsageSignal.Builder clone()
Returns
TypeDescription
UsageSignal.Builder
Overrides

containsCommonUsageWithinTimeRange(String key)

public boolean containsCommonUsageWithinTimeRange(String key)

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsUsageWithinTimeRange(String key)

public boolean containsUsageWithinTimeRange(String key)

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCommonUsageWithinTimeRange()

public Map<String,CommonUsageStats> getCommonUsageWithinTimeRange()
Returns
TypeDescription
Map<String,CommonUsageStats>

getCommonUsageWithinTimeRangeCount()

public int getCommonUsageWithinTimeRangeCount()

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Returns
TypeDescription
int

getCommonUsageWithinTimeRangeMap()

public Map<String,CommonUsageStats> getCommonUsageWithinTimeRangeMap()

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Returns
TypeDescription
Map<String,CommonUsageStats>

getCommonUsageWithinTimeRangeOrDefault(String key, CommonUsageStats defaultValue)

public CommonUsageStats getCommonUsageWithinTimeRangeOrDefault(String key, CommonUsageStats defaultValue)

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Parameters
NameDescription
keyString
defaultValueCommonUsageStats
Returns
TypeDescription
CommonUsageStats

getCommonUsageWithinTimeRangeOrThrow(String key)

public CommonUsageStats getCommonUsageWithinTimeRangeOrThrow(String key)

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
CommonUsageStats

getDefaultInstanceForType()

public UsageSignal getDefaultInstanceForType()
Returns
TypeDescription
UsageSignal

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFavoriteCount()

public long getFavoriteCount()

Favorite count in the source system.

optional int64 favorite_count = 4;

Returns
TypeDescription
long

The favoriteCount.

getMutableCommonUsageWithinTimeRange()

public Map<String,CommonUsageStats> getMutableCommonUsageWithinTimeRange()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,CommonUsageStats>

getMutableUsageWithinTimeRange()

public Map<String,UsageStats> getMutableUsageWithinTimeRange()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,UsageStats>

getUpdateTime()

public Timestamp getUpdateTime()

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getUsageWithinTimeRange()

public Map<String,UsageStats> getUsageWithinTimeRange()
Returns
TypeDescription
Map<String,UsageStats>

getUsageWithinTimeRangeCount()

public int getUsageWithinTimeRangeCount()

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getUsageWithinTimeRangeMap()

public Map<String,UsageStats> getUsageWithinTimeRangeMap()

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Map<String,UsageStats>

getUsageWithinTimeRangeOrDefault(String key, UsageStats defaultValue)

public UsageStats getUsageWithinTimeRangeOrDefault(String key, UsageStats defaultValue)

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
keyString
defaultValueUsageStats
Returns
TypeDescription
UsageStats

getUsageWithinTimeRangeOrThrow(String key)

public UsageStats getUsageWithinTimeRangeOrThrow(String key)

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
keyString
Returns
TypeDescription
UsageStats

hasFavoriteCount()

public boolean hasFavoriteCount()

Favorite count in the source system.

optional int64 favorite_count = 4;

Returns
TypeDescription
boolean

Whether the favoriteCount field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UsageSignal other)

public UsageSignal.Builder mergeFrom(UsageSignal other)
Parameter
NameDescription
otherUsageSignal
Returns
TypeDescription
UsageSignal.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UsageSignal.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UsageSignal.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UsageSignal.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UsageSignal.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UsageSignal.Builder
Overrides

mergeUpdateTime(Timestamp value)

public UsageSignal.Builder mergeUpdateTime(Timestamp value)

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
UsageSignal.Builder

putAllCommonUsageWithinTimeRange(Map<String,CommonUsageStats> values)

public UsageSignal.Builder putAllCommonUsageWithinTimeRange(Map<String,CommonUsageStats> values)

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Parameter
NameDescription
valuesMap<String,CommonUsageStats>
Returns
TypeDescription
UsageSignal.Builder

putAllUsageWithinTimeRange(Map<String,UsageStats> values)

public UsageSignal.Builder putAllUsageWithinTimeRange(Map<String,UsageStats> values)

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesMap<String,UsageStats>
Returns
TypeDescription
UsageSignal.Builder

putCommonUsageWithinTimeRange(String key, CommonUsageStats value)

public UsageSignal.Builder putCommonUsageWithinTimeRange(String key, CommonUsageStats value)

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Parameters
NameDescription
keyString
valueCommonUsageStats
Returns
TypeDescription
UsageSignal.Builder

putUsageWithinTimeRange(String key, UsageStats value)

public UsageSignal.Builder putUsageWithinTimeRange(String key, UsageStats value)

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
keyString
valueUsageStats
Returns
TypeDescription
UsageSignal.Builder

removeCommonUsageWithinTimeRange(String key)

public UsageSignal.Builder removeCommonUsageWithinTimeRange(String key)

Common usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D", "Lifetime"}.

map<string, .google.cloud.datacatalog.v1.CommonUsageStats> common_usage_within_time_range = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
UsageSignal.Builder

removeUsageWithinTimeRange(String key)

public UsageSignal.Builder removeUsageWithinTimeRange(String key)

Output only. BigQuery usage statistics over each of the predefined time ranges.

Supported time ranges are {"24H", "7D", "30D"}.

map<string, .google.cloud.datacatalog.v1.UsageStats> usage_within_time_range = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
keyString
Returns
TypeDescription
UsageSignal.Builder

setFavoriteCount(long value)

public UsageSignal.Builder setFavoriteCount(long value)

Favorite count in the source system.

optional int64 favorite_count = 4;

Parameter
NameDescription
valuelong

The favoriteCount to set.

Returns
TypeDescription
UsageSignal.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UsageSignal.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UsageSignal.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UsageSignal.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UsageSignal.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UsageSignal.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UsageSignal.Builder
Overrides

setUpdateTime(Timestamp value)

public UsageSignal.Builder setUpdateTime(Timestamp value)

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
UsageSignal.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public UsageSignal.Builder setUpdateTime(Timestamp.Builder builderForValue)

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
UsageSignal.Builder