Package com.google.cloud.datacatalog.v1

Class UsageSignal

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1.UsageSignal
All Implemented Interfaces:
UsageSignalOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class UsageSignal extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER

      public static final int USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER
      See Also:

    • COMMON_USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER

      public static final int COMMON_USAGE_WITHIN_TIME_RANGE_FIELD_NUMBER
      See Also:

    • FAVORITE_COUNT_FIELD_NUMBER

      public static final int FAVORITE_COUNT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasUpdateTime

      public boolean hasUpdateTime()
       The end timestamp of the duration of usage statistics.
      .google.protobuf.Timestamp update_time = 1;
      Specified by:
      hasUpdateTime in interface UsageSignalOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       The end timestamp of the duration of usage statistics.
      .google.protobuf.Timestamp update_time = 1;
      Specified by:
      getUpdateTime in interface UsageSignalOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       The end timestamp of the duration of usage statistics.
      .google.protobuf.Timestamp update_time = 1;
      Specified by:
      getUpdateTimeOrBuilder in interface UsageSignalOrBuilder

    • getUsageWithinTimeRangeCount

      public int getUsageWithinTimeRangeCount()
      Description copied from interface: UsageSignalOrBuilder
       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];
      Specified by:
      getUsageWithinTimeRangeCount in interface UsageSignalOrBuilder

    • containsUsageWithinTimeRange

      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];
      Specified by:
      containsUsageWithinTimeRange in interface UsageSignalOrBuilder

    • getUsageWithinTimeRange

      @Deprecated public Map<String,UsageStats> getUsageWithinTimeRange()
      Deprecated.
      Use getUsageWithinTimeRangeMap() instead.
      Specified by:
      getUsageWithinTimeRange in interface UsageSignalOrBuilder

    • 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];
      Specified by:
      getUsageWithinTimeRangeMap in interface UsageSignalOrBuilder

    • getUsageWithinTimeRangeOrDefault

      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];
      Specified by:
      getUsageWithinTimeRangeOrDefault in interface UsageSignalOrBuilder

    • getUsageWithinTimeRangeOrThrow

      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];
      Specified by:
      getUsageWithinTimeRangeOrThrow in interface UsageSignalOrBuilder

    • getCommonUsageWithinTimeRangeCount

      public int getCommonUsageWithinTimeRangeCount()
      Description copied from interface: UsageSignalOrBuilder
       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;
      Specified by:
      getCommonUsageWithinTimeRangeCount in interface UsageSignalOrBuilder

    • containsCommonUsageWithinTimeRange

      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;
      Specified by:
      containsCommonUsageWithinTimeRange in interface UsageSignalOrBuilder

    • getCommonUsageWithinTimeRange

      @Deprecated public Map<String,CommonUsageStats> getCommonUsageWithinTimeRange()
      Deprecated.
      Use getCommonUsageWithinTimeRangeMap() instead.
      Specified by:
      getCommonUsageWithinTimeRange in interface UsageSignalOrBuilder

    • 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;
      Specified by:
      getCommonUsageWithinTimeRangeMap in interface UsageSignalOrBuilder

    • getCommonUsageWithinTimeRangeOrDefault

      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;
      Specified by:
      getCommonUsageWithinTimeRangeOrDefault in interface UsageSignalOrBuilder

    • getCommonUsageWithinTimeRangeOrThrow

      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;
      Specified by:
      getCommonUsageWithinTimeRangeOrThrow in interface UsageSignalOrBuilder

    • hasFavoriteCount

      public boolean hasFavoriteCount()
       Favorite count in the source system.
      optional int64 favorite_count = 4;
      Specified by:
      hasFavoriteCount in interface UsageSignalOrBuilder
      Returns:
      Whether the favoriteCount field is set.

    • getFavoriteCount

      public long getFavoriteCount()
       Favorite count in the source system.
      optional int64 favorite_count = 4;
      Specified by:
      getFavoriteCount in interface UsageSignalOrBuilder
      Returns:
      The favoriteCount.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UsageSignal parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UsageSignal parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UsageSignal parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UsageSignal parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UsageSignal parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UsageSignal parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UsageSignal parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UsageSignal parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UsageSignal parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UsageSignal parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UsageSignal parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UsageSignal parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UsageSignal.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UsageSignal.Builder newBuilder()

    • newBuilder

      public static UsageSignal.Builder newBuilder(UsageSignal prototype)

    • toBuilder

      public UsageSignal.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UsageSignal.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static UsageSignal getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UsageSignal> parser()

    • getParserForType

      public com.google.protobuf.Parser<UsageSignal> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public UsageSignal getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder