Class UsageSignal (1.59.0) 

public final class UsageSignal extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UsageSignal

Static Fields

COMMON_USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER

public static final int COMMON_USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER
Field Value
Type Description
int

FAVORITE_COUNT_FIELD_NUMBER

public static final int FAVORITE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER

public static final int USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UsageSignal getDefaultInstance()
Returns
Type Description
UsageSignal

getDescriptor()

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

newBuilder()

public static UsageSignal.Builder newBuilder()
Returns
Type Description
UsageSignal.Builder

newBuilder(UsageSignal prototype)

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

parseDelimitedFrom(InputStream input)

public static UsageSignal parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UsageSignal
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static UsageSignal parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UsageSignal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static UsageSignal parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UsageSignal
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static UsageSignal parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UsageSignal
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static UsageSignal parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UsageSignal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<UsageSignal> parser()
Returns
Type Description
Parser<UsageSignal>

Methods

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

equals(Object obj)

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

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

getFavoriteCount()

public long getFavoriteCount()

Favorite count in the source system.

optional int64 favorite_count = 4;

Returns
Type Description
long

The favoriteCount.

getParserForType()

public Parser<UsageSignal> getParserForType()
Returns
Type Description
Parser<UsageSignal>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UsageSignal.Builder newBuilderForType()
Returns
Type Description
UsageSignal.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UsageSignal.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UsageSignal.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UsageSignal.Builder toBuilder()
Returns
Type Description
UsageSignal.Builder

writeTo(CodedOutputStream output)

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