Class: Google::Cloud::Chronicle::V1::DashboardFilter

Inherits:

Object

• Object
• Google::Cloud::Chronicle::V1::DashboardFilter

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/chronicle/v1/dashboard_query.rb

Overview

Dashboard level filter that can be used in native dashboards as well as inputs to execute query.

Instance Attribute Summary

• #advanced_filter_config ⇒ ::Google::Cloud::Chronicle::V1::AdvancedFilterConfig

  Optional.

• #chart_ids ⇒ ::Array<::String>

  Chart IDs the filter is applicable for.

• #data_source ⇒ ::Google::Cloud::Chronicle::V1::DataSource

  Datasource the filter is applicable for.

• #display_name ⇒ ::String

  Display name of the filter.

• #field_path ⇒ ::String

  Filter field path.

• #filter_operator_and_field_values ⇒ ::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>

  Operator and values.

• #id ⇒ ::String

  ID of the filter.

• #is_mandatory ⇒ ::Boolean

  Optional.

• #is_standard_time_range_filter ⇒ ::Boolean

  Optional.

• #is_standard_time_range_filter_enabled ⇒ ::Boolean

  Optional.

Instance Attribute Details

#advanced_filter_config ⇒ ::Google::Cloud::Chronicle::V1::AdvancedFilterConfig

Returns Optional. Advanced filter configuration for the filter widget.

Returns:

• (::Google::Cloud::Chronicle::V1::AdvancedFilterConfig) —

  Optional. Advanced filter configuration for the filter widget.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#chart_ids ⇒ ::Array<::String>

Returns Chart IDs the filter is applicable for.

Returns:

• (::Array<::String>) —

  Chart IDs the filter is applicable for.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_source ⇒ ::Google::Cloud::Chronicle::V1::DataSource

Returns Datasource the filter is applicable for.

Returns:

• (::Google::Cloud::Chronicle::V1::DataSource) —

  Datasource the filter is applicable for.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Display name of the filter.

Returns:

• (::String) —

  Display name of the filter.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#field_path ⇒ ::String

Returns Filter field path.

Returns:

• (::String) —

  Filter field path.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter_operator_and_field_values ⇒ ::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>

Returns Operator and values. Can include multiple modifiers.

Returns:

• (::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>) —

  Operator and values. Can include multiple modifiers.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::String

Returns ID of the filter.

Returns:

• (::String) —

  ID of the filter.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#is_mandatory ⇒ ::Boolean

Returns Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.

Returns:

• (::Boolean) —

  Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#is_standard_time_range_filter ⇒ ::Boolean

Returns 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.

Returns:

• (::Boolean) —

  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.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#is_standard_time_range_filter_enabled ⇒ ::Boolean

Returns Optional. Whether this standard time range filter is enabled.

Returns:

• (::Boolean) —

  Optional. Whether this standard time range filter is enabled.

# File 'proto_docs/google/cloud/chronicle/v1/dashboard_query.rb', line 352

class DashboardFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end