Class UsageSignal.Builder

  • All Implemented Interfaces:
    UsageSignalOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    UsageSignal

    public static final class UsageSignal.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
    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
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • clear

        public UsageSignal.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • getDefaultInstanceForType

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

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

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

        public UsageSignal.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • setField

        public UsageSignal.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • clearField

        public UsageSignal.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • clearOneof

        public UsageSignal.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • setRepeatedField

        public UsageSignal.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • addRepeatedField

        public UsageSignal.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • mergeFrom

        public UsageSignal.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UsageSignal.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • mergeFrom

        public UsageSignal.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UsageSignal.Builder>
        Throws:
        IOException
      • 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.
      • setUpdateTime

        public UsageSignal.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         The end timestamp of the duration of usage statistics.
         
        .google.protobuf.Timestamp update_time = 1;
      • setUpdateTime

        public UsageSignal.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The end timestamp of the duration of usage statistics.
         
        .google.protobuf.Timestamp update_time = 1;
      • mergeUpdateTime

        public UsageSignal.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         The end timestamp of the duration of usage statistics.
         
        .google.protobuf.Timestamp update_time = 1;
      • clearUpdateTime

        public UsageSignal.Builder clearUpdateTime()
         The end timestamp of the duration of usage statistics.
         
        .google.protobuf.Timestamp update_time = 1;
      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         The end timestamp of the duration of usage statistics.
         
        .google.protobuf.Timestamp update_time = 1;
      • 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
      • 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
      • removeUsageWithinTimeRange

        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];
      • getMutableUsageWithinTimeRange

        @Deprecated
        public Map<String,​UsageStats> getMutableUsageWithinTimeRange()
        Deprecated.
        Use alternate mutation accessors instead.
      • putUsageWithinTimeRange

        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];
      • putAllUsageWithinTimeRange

        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];
      • 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
      • 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
      • 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
      • clearCommonUsageWithinTimeRange

        public UsageSignal.Builder clearCommonUsageWithinTimeRange()
      • removeCommonUsageWithinTimeRange

        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;
      • getMutableCommonUsageWithinTimeRange

        @Deprecated
        public Map<String,​CommonUsageStats> getMutableCommonUsageWithinTimeRange()
        Deprecated.
        Use alternate mutation accessors instead.
      • putCommonUsageWithinTimeRange

        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;
      • putAllCommonUsageWithinTimeRange

        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;
      • 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.
      • setFavoriteCount

        public UsageSignal.Builder setFavoriteCount​(long value)
         Favorite count in the source system.
         
        optional int64 favorite_count = 4;
        Parameters:
        value - The favoriteCount to set.
        Returns:
        This builder for chaining.
      • clearFavoriteCount

        public UsageSignal.Builder clearFavoriteCount()
         Favorite count in the source system.
         
        optional int64 favorite_count = 4;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final UsageSignal.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>
      • mergeUnknownFields

        public final UsageSignal.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UsageSignal.Builder>