- 1.84.0 (latest)
 - 1.82.0
 - 1.81.0
 - 1.80.0
 - 1.79.0
 - 1.78.0
 - 1.76.0
 - 1.74.0
 - 1.73.0
 - 1.70.0
 - 1.69.0
 - 1.68.0
 - 1.66.0
 - 1.65.0
 - 1.64.0
 - 1.63.0
 - 1.62.0
 - 1.61.0
 - 1.60.0
 - 1.59.0
 - 1.58.0
 - 1.57.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.50.0
 - 1.49.0
 - 1.48.0
 - 1.47.0
 - 1.46.0
 - 1.45.0
 - 1.43.0
 - 1.42.0
 - 1.41.0
 - 1.40.0
 - 1.39.0
 - 1.38.0
 - 1.37.0
 - 1.36.0
 - 1.35.0
 - 1.34.0
 - 1.33.0
 - 1.30.0
 - 1.29.0
 - 1.28.0
 - 1.27.0
 - 1.26.0
 - 1.25.0
 - 1.24.0
 - 1.23.0
 - 1.22.0
 - 1.21.0
 - 1.20.0
 - 1.19.0
 - 1.18.0
 - 1.17.0
 - 1.15.0
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 - 1.9.5
 - 1.8.4
 - 1.7.2
 - 1.6.2
 - 1.5.4
 
public static final class UsageSignal.Builder extends GeneratedMessageV3.Builder<UsageSignal.Builder> implements UsageSignalOrBuilderThe 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UsageSignal.BuilderImplements
UsageSignalOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UsageSignal.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
build()
public UsageSignal build()| Returns | |
|---|---|
| Type | Description | 
UsageSignal | 
        |
buildPartial()
public UsageSignal buildPartial()| Returns | |
|---|---|
| Type | Description | 
UsageSignal | 
        |
clear()
public UsageSignal.Builder clear()| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
clearCommonUsageWithinTimeRange()
public UsageSignal.Builder clearCommonUsageWithinTimeRange()| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
clearFavoriteCount()
public UsageSignal.Builder clearFavoriteCount()Favorite count in the source system.
 optional int64 favorite_count = 4;
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        This builder for chaining.  | 
      
clearField(Descriptors.FieldDescriptor field)
public UsageSignal.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
clearOneof(Descriptors.OneofDescriptor oneof)
public UsageSignal.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
clearUpdateTime()
public UsageSignal.Builder clearUpdateTime()The end timestamp of the duration of usage statistics.
 .google.protobuf.Timestamp update_time = 1;
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
clearUsageWithinTimeRange()
public UsageSignal.Builder clearUsageWithinTimeRange()| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
clone()
public UsageSignal.Builder clone()| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
getCommonUsageWithinTimeRange() (deprecated)
public Map<String,CommonUsageStats> getCommonUsageWithinTimeRange()Use #getCommonUsageWithinTimeRangeMap() instead.
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
defaultValue | 
        CommonUsageStats | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonUsageStats | 
        |
getDefaultInstanceForType()
public UsageSignal getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
UsageSignal | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getFavoriteCount()
public long getFavoriteCount()Favorite count in the source system.
 optional int64 favorite_count = 4;
| Returns | |
|---|---|
| Type | Description | 
long | 
        The favoriteCount.  | 
      
getMutableCommonUsageWithinTimeRange() (deprecated)
public Map<String,CommonUsageStats> getMutableCommonUsageWithinTimeRange()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description | 
Map<String,CommonUsageStats> | 
        |
getMutableUsageWithinTimeRange() (deprecated)
public Map<String,UsageStats> getMutableUsageWithinTimeRange()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description | 
Map<String,UsageStats> | 
        |
getUpdateTime()
public Timestamp getUpdateTime()The end timestamp of the duration of usage statistics.
 .google.protobuf.Timestamp update_time = 1;
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The updateTime.  | 
      
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()The end timestamp of the duration of usage statistics.
 .google.protobuf.Timestamp update_time = 1;
| Returns | |
|---|---|
| Type | Description | 
Builder | 
        |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()The end timestamp of the duration of usage statistics.
 .google.protobuf.Timestamp update_time = 1;
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
getUsageWithinTimeRange() (deprecated)
public Map<String,UsageStats> getUsageWithinTimeRange()Use #getUsageWithinTimeRangeMap() instead.
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
defaultValue | 
        UsageStats | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageStats | 
        |
hasFavoriteCount()
public boolean hasFavoriteCount()Favorite count in the source system.
 optional int64 favorite_count = 4;
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Type | Description | 
boolean | 
        Whether the updateTime field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description | 
number | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
com.google.protobuf.MapFieldReflectionAccessor | 
        |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description | 
number | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
com.google.protobuf.MapFieldReflectionAccessor | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeFrom(UsageSignal other)
public UsageSignal.Builder mergeFrom(UsageSignal other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        UsageSignal | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UsageSignal.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public UsageSignal.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UsageSignal.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
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 | |
|---|---|
| Name | Description | 
value | 
        Timestamp | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
values | 
        Map<String,CommonUsageStats> | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
values | 
        Map<String,UsageStats> | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
value | 
        CommonUsageStats | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
putCommonUsageWithinTimeRangeBuilderIfAbsent(String key)
public CommonUsageStats.Builder putCommonUsageWithinTimeRangeBuilderIfAbsent(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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonUsageStats.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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
value | 
        UsageStats | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
putUsageWithinTimeRangeBuilderIfAbsent(String key)
public UsageStats.Builder putUsageWithinTimeRangeBuilderIfAbsent(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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageStats.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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
setFavoriteCount(long value)
public UsageSignal.Builder setFavoriteCount(long value)Favorite count in the source system.
 optional int64 favorite_count = 4;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        longThe favoriteCount to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        This builder for chaining.  | 
      
setField(Descriptors.FieldDescriptor field, Object value)
public UsageSignal.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UsageSignal.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final UsageSignal.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |
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 | |
|---|---|
| Name | Description | 
value | 
        Timestamp | 
      
| Returns | |
|---|---|
| Type | Description | 
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 | |
|---|---|
| Name | Description | 
builderForValue | 
        Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
UsageSignal.Builder | 
        |