Chronicle v1 API - Class DashboardFilter (1.0.0-beta05)

public sealed class DashboardFilter : IMessage<DashboardFilter>, IEquatable<DashboardFilter>, IDeepCloneable<DashboardFilter>, IBufferMessage, IMessage

Reference documentation and code samples for the Chronicle v1 API class DashboardFilter.

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

Inheritance

object > DashboardFilter

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DashboardFilter()

public DashboardFilter()

DashboardFilter(DashboardFilter)

public DashboardFilter(DashboardFilter other)
Parameter
Name Description
other DashboardFilter

Properties

AdvancedFilterConfig

public AdvancedFilterConfig AdvancedFilterConfig { get; set; }

Optional. Advanced filter configuration for the filter widget.

Property Value
Type Description
AdvancedFilterConfig

ChartIds

public RepeatedField<string> ChartIds { get; }

Chart IDs the filter is applicable for.

Property Value
Type Description
RepeatedFieldstring

DataSource

public DataSource DataSource { get; set; }

Datasource the filter is applicable for.

Property Value
Type Description
DataSource

DisplayName

public string DisplayName { get; set; }

Display name of the filter.

Property Value
Type Description
string

FieldPath

public string FieldPath { get; set; }

Filter field path.

Property Value
Type Description
string

FilterOperatorAndFieldValues

public RepeatedField<FilterOperatorAndValues> FilterOperatorAndFieldValues { get; }

Operator and values. Can include multiple modifiers.

Property Value
Type Description
RepeatedFieldFilterOperatorAndValues

HasIsStandardTimeRangeFilterEnabled

public bool HasIsStandardTimeRangeFilterEnabled { get; }

Gets whether the "is_standard_time_range_filter_enabled" field is set

Property Value
Type Description
bool

Id

public string Id { get; set; }

ID of the filter.

Property Value
Type Description
string

IsMandatory

public bool IsMandatory { get; set; }

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

Property Value
Type Description
bool

IsStandardTimeRangeFilter

public bool IsStandardTimeRangeFilter { get; set; }

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.

Property Value
Type Description
bool

IsStandardTimeRangeFilterEnabled

public bool IsStandardTimeRangeFilterEnabled { get; set; }

Optional. Whether this standard time range filter is enabled.

Property Value
Type Description
bool