Class UsageSignal (1.30.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

Static Fields

COMMON_USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER

public static final int COMMON_USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

FAVORITE_COUNT_FIELD_NUMBER

public static final int FAVORITE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER

public static final int USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UsageSignal getDefaultInstance()
Returns
TypeDescription
UsageSignal

getDescriptor()

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

newBuilder()

public static UsageSignal.Builder newBuilder()
Returns
TypeDescription
UsageSignal.Builder

newBuilder(UsageSignal prototype)

public static UsageSignal.Builder newBuilder(UsageSignal prototype)
Parameter
NameDescription
prototypeUsageSignal
Returns
TypeDescription
UsageSignal.Builder

parseDelimitedFrom(InputStream input)

public static UsageSignal parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UsageSignal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UsageSignal parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UsageSignal parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UsageSignal parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UsageSignal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UsageSignal parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UsageSignal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UsageSignal parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UsageSignal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UsageSignal parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UsageSignal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsageSignal
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UsageSignal> parser()
Returns
TypeDescription
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
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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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

getFavoriteCount()

public long getFavoriteCount()

Favorite count in the source system.

optional int64 favorite_count = 4;

Returns
TypeDescription
long

The favoriteCount.

getParserForType()

public Parser<UsageSignal> getParserForType()
Returns
TypeDescription
Parser<UsageSignal>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

The end timestamp of the duration of usage statistics.

.google.protobuf.Timestamp update_time = 1;

Returns
TypeDescription
Timestamp

The updateTime.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UsageSignal.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UsageSignal.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException