Package com.google.cloud.chronicle.v1

Class DashboardFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.chronicle.v1.DashboardFilter
All Implemented Interfaces:
DashboardFilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DashboardFilter extends com.google.protobuf.GeneratedMessage implements DashboardFilterOrBuilder
 Dashboard level filter that can be used in native dashboards as well as
 inputs to execute query.
Protobuf type google.cloud.chronicle.v1.DashboardFilter
See Also:

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • DATA_SOURCE_FIELD_NUMBER

      public static final int DATA_SOURCE_FIELD_NUMBER
      See Also:

    • FIELD_PATH_FIELD_NUMBER

      public static final int FIELD_PATH_FIELD_NUMBER
      See Also:

    • FILTER_OPERATOR_AND_FIELD_VALUES_FIELD_NUMBER

      public static final int FILTER_OPERATOR_AND_FIELD_VALUES_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • CHART_IDS_FIELD_NUMBER

      public static final int CHART_IDS_FIELD_NUMBER
      See Also:

    • IS_STANDARD_TIME_RANGE_FILTER_FIELD_NUMBER

      public static final int IS_STANDARD_TIME_RANGE_FILTER_FIELD_NUMBER
      See Also:

    • IS_MANDATORY_FIELD_NUMBER

      public static final int IS_MANDATORY_FIELD_NUMBER
      See Also:

    • IS_STANDARD_TIME_RANGE_FILTER_ENABLED_FIELD_NUMBER

      public static final int IS_STANDARD_TIME_RANGE_FILTER_ENABLED_FIELD_NUMBER
      See Also:

    • ADVANCED_FILTER_CONFIG_FIELD_NUMBER

      public static final int ADVANCED_FILTER_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getId

      public String getId()
       ID of the filter.
      string id = 1;
      Specified by:
      getId in interface DashboardFilterOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       ID of the filter.
      string id = 1;
      Specified by:
      getIdBytes in interface DashboardFilterOrBuilder
      Returns:
      The bytes for id.

    • getDataSourceValue

      public int getDataSourceValue()
       Datasource the filter is applicable for.
      .google.cloud.chronicle.v1.DataSource data_source = 2;
      Specified by:
      getDataSourceValue in interface DashboardFilterOrBuilder
      Returns:
      The enum numeric value on the wire for dataSource.

    • getDataSource

      public DataSource getDataSource()
       Datasource the filter is applicable for.
      .google.cloud.chronicle.v1.DataSource data_source = 2;
      Specified by:
      getDataSource in interface DashboardFilterOrBuilder
      Returns:
      The dataSource.

    • getFieldPath

      public String getFieldPath()
       Filter field path.
      string field_path = 3;
      Specified by:
      getFieldPath in interface DashboardFilterOrBuilder
      Returns:
      The fieldPath.

    • getFieldPathBytes

      public com.google.protobuf.ByteString getFieldPathBytes()
       Filter field path.
      string field_path = 3;
      Specified by:
      getFieldPathBytes in interface DashboardFilterOrBuilder
      Returns:
      The bytes for fieldPath.

    • getFilterOperatorAndFieldValuesList

      public List<FilterOperatorAndValues> getFilterOperatorAndFieldValuesList()
       Operator and values. Can include multiple modifiers.
      repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;
      Specified by:
      getFilterOperatorAndFieldValuesList in interface DashboardFilterOrBuilder

    • getFilterOperatorAndFieldValuesOrBuilderList

      public List<? extends FilterOperatorAndValuesOrBuilder> getFilterOperatorAndFieldValuesOrBuilderList()
       Operator and values. Can include multiple modifiers.
      repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;
      Specified by:
      getFilterOperatorAndFieldValuesOrBuilderList in interface DashboardFilterOrBuilder

    • getFilterOperatorAndFieldValuesCount

      public int getFilterOperatorAndFieldValuesCount()
       Operator and values. Can include multiple modifiers.
      repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;
      Specified by:
      getFilterOperatorAndFieldValuesCount in interface DashboardFilterOrBuilder

    • getFilterOperatorAndFieldValues

      public FilterOperatorAndValues getFilterOperatorAndFieldValues(int index)
       Operator and values. Can include multiple modifiers.
      repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;
      Specified by:
      getFilterOperatorAndFieldValues in interface DashboardFilterOrBuilder

    • getFilterOperatorAndFieldValuesOrBuilder

      public FilterOperatorAndValuesOrBuilder getFilterOperatorAndFieldValuesOrBuilder(int index)
       Operator and values. Can include multiple modifiers.
      repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;
      Specified by:
      getFilterOperatorAndFieldValuesOrBuilder in interface DashboardFilterOrBuilder

    • getDisplayName

      public String getDisplayName()
       Display name of the filter.
      string display_name = 5;
      Specified by:
      getDisplayName in interface DashboardFilterOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Display name of the filter.
      string display_name = 5;
      Specified by:
      getDisplayNameBytes in interface DashboardFilterOrBuilder
      Returns:
      The bytes for displayName.

    • getChartIdsList

      public com.google.protobuf.ProtocolStringList getChartIdsList()
       Chart IDs the filter is applicable for.
      repeated string chart_ids = 6;
      Specified by:
      getChartIdsList in interface DashboardFilterOrBuilder
      Returns:
      A list containing the chartIds.

    • getChartIdsCount

      public int getChartIdsCount()
       Chart IDs the filter is applicable for.
      repeated string chart_ids = 6;
      Specified by:
      getChartIdsCount in interface DashboardFilterOrBuilder
      Returns:
      The count of chartIds.

    • getChartIds

      public String getChartIds(int index)
       Chart IDs the filter is applicable for.
      repeated string chart_ids = 6;
      Specified by:
      getChartIds in interface DashboardFilterOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The chartIds at the given index.

    • getChartIdsBytes

      public com.google.protobuf.ByteString getChartIdsBytes(int index)
       Chart IDs the filter is applicable for.
      repeated string chart_ids = 6;
      Specified by:
      getChartIdsBytes in interface DashboardFilterOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the chartIds at the given index.

    • getIsStandardTimeRangeFilter

      public boolean getIsStandardTimeRangeFilter()
       Optional. Whether the filter is a standard time range filter,
 meaning that it has to be used as the query time range,
 and not as a predicate in the query.
 A chart can have at most one standard time range filter applied.
      bool is_standard_time_range_filter = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIsStandardTimeRangeFilter in interface DashboardFilterOrBuilder
      Returns:
      The isStandardTimeRangeFilter.

    • getIsMandatory

      public boolean getIsMandatory()
       Optional. Whether this filter is required to be populated by the
 dashboard consumer prior to the dashboard loading.
      bool is_mandatory = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIsMandatory in interface DashboardFilterOrBuilder
      Returns:
      The isMandatory.

    • hasIsStandardTimeRangeFilterEnabled

      public boolean hasIsStandardTimeRangeFilterEnabled()
       Optional. Whether this standard time range filter is enabled.
      optional bool is_standard_time_range_filter_enabled = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasIsStandardTimeRangeFilterEnabled in interface DashboardFilterOrBuilder
      Returns:
      Whether the isStandardTimeRangeFilterEnabled field is set.

    • getIsStandardTimeRangeFilterEnabled

      public boolean getIsStandardTimeRangeFilterEnabled()
       Optional. Whether this standard time range filter is enabled.
      optional bool is_standard_time_range_filter_enabled = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIsStandardTimeRangeFilterEnabled in interface DashboardFilterOrBuilder
      Returns:
      The isStandardTimeRangeFilterEnabled.

    • hasAdvancedFilterConfig

      public boolean hasAdvancedFilterConfig()
       Optional. Advanced filter configuration for the filter widget.
      .google.cloud.chronicle.v1.AdvancedFilterConfig advanced_filter_config = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAdvancedFilterConfig in interface DashboardFilterOrBuilder
      Returns:
      Whether the advancedFilterConfig field is set.

    • getAdvancedFilterConfig

      public AdvancedFilterConfig getAdvancedFilterConfig()
       Optional. Advanced filter configuration for the filter widget.
      .google.cloud.chronicle.v1.AdvancedFilterConfig advanced_filter_config = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdvancedFilterConfig in interface DashboardFilterOrBuilder
      Returns:
      The advancedFilterConfig.

    • getAdvancedFilterConfigOrBuilder

      public AdvancedFilterConfigOrBuilder getAdvancedFilterConfigOrBuilder()
       Optional. Advanced filter configuration for the filter widget.
      .google.cloud.chronicle.v1.AdvancedFilterConfig advanced_filter_config = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdvancedFilterConfigOrBuilder in interface DashboardFilterOrBuilder

    • 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 DashboardFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DashboardFilter.Builder newBuilder()

    • newBuilder

      public static DashboardFilter.Builder newBuilder(DashboardFilter prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DashboardFilter getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DashboardFilter> 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 DashboardFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder