Class: Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/dashboard/v1/dashboard_filter.rb

Overview

A filter to reduce the amount of data charted in relevant widgets.

Defined Under Namespace

Modules: FilterType

Instance Attribute Summary collapse

Instance Attribute Details

#filter_type ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter::FilterType

Returns The specified filter type.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/monitoring/dashboard/v1/dashboard_filter.rb', line 40

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

  # The type for the dashboard filter
  module FilterType
    # Filter type is unspecified. This is not valid in a well-formed request.
    FILTER_TYPE_UNSPECIFIED = 0

    # Filter on a resource label value
    RESOURCE_LABEL = 1

    # Filter on a metrics label value
    METRIC_LABEL = 2

    # Filter on a user metadata label value
    USER_METADATA_LABEL = 3

    # Filter on a system metadata label value
    SYSTEM_METADATA_LABEL = 4

    # Filter on a group id
    GROUP = 5
  end
end

#label_key ⇒ ::String

Returns Required. The key for the label.

Returns:

  • (::String) —

    Required. The key for the label



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/monitoring/dashboard/v1/dashboard_filter.rb', line 40

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

  # The type for the dashboard filter
  module FilterType
    # Filter type is unspecified. This is not valid in a well-formed request.
    FILTER_TYPE_UNSPECIFIED = 0

    # Filter on a resource label value
    RESOURCE_LABEL = 1

    # Filter on a metrics label value
    METRIC_LABEL = 2

    # Filter on a user metadata label value
    USER_METADATA_LABEL = 3

    # Filter on a system metadata label value
    SYSTEM_METADATA_LABEL = 4

    # Filter on a group id
    GROUP = 5
  end
end

#string_value ⇒ ::String

Returns A variable-length string value.

Returns:

  • (::String) —

    A variable-length string value.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/monitoring/dashboard/v1/dashboard_filter.rb', line 40

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

  # The type for the dashboard filter
  module FilterType
    # Filter type is unspecified. This is not valid in a well-formed request.
    FILTER_TYPE_UNSPECIFIED = 0

    # Filter on a resource label value
    RESOURCE_LABEL = 1

    # Filter on a metrics label value
    METRIC_LABEL = 2

    # Filter on a user metadata label value
    USER_METADATA_LABEL = 3

    # Filter on a system metadata label value
    SYSTEM_METADATA_LABEL = 4

    # Filter on a group id
    GROUP = 5
  end
end

#template_variable ⇒ ::String

Returns The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

Returns:

  • (::String) —

    The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/monitoring/dashboard/v1/dashboard_filter.rb', line 40

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

  # The type for the dashboard filter
  module FilterType
    # Filter type is unspecified. This is not valid in a well-formed request.
    FILTER_TYPE_UNSPECIFIED = 0

    # Filter on a resource label value
    RESOURCE_LABEL = 1

    # Filter on a metrics label value
    METRIC_LABEL = 2

    # Filter on a user metadata label value
    USER_METADATA_LABEL = 3

    # Filter on a system metadata label value
    SYSTEM_METADATA_LABEL = 4

    # Filter on a group id
    GROUP = 5
  end
end