Class UsageSignal (1.21.0)

Version 1.21.0

• 1.58.0 (latest)
• 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 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

Implements

UsageSignalOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

getCommonUsageWithinTimeRange()

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public UsageSignal.Builder toBuilder()

Returns
Type	Description
UsageSignal.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException