Class: Google::Cloud::Monitoring::V3::ServiceLevelObjective

Inherits:

Object

• Object
• Google::Cloud::Monitoring::V3::ServiceLevelObjective

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/monitoring/v3/service.rb

Overview

A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."

Defined Under Namespace

Modules: View Classes: UserLabelsEntry

Instance Attribute Summary

• #calendar_period ⇒ ::Google::Type::CalendarPeriod

  A calendar period, semantically "since the start of the current <calendar_period>".

• #display_name ⇒ ::String

  Name used for UI elements listing this SLO.

• #goal ⇒ ::Float

  The fraction of service that must be good in order for this objective to be met.

• #name ⇒ ::String

  Identifier.

• #rolling_period ⇒ ::Google::Protobuf::Duration

  A rolling time period, semantically "in the past <rolling_period>".

• #service_level_indicator ⇒ ::Google::Cloud::Monitoring::V3::ServiceLevelIndicator

  The definition of good service, used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality.

• #user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  Labels which have been used to annotate the service-level objective.

Instance Attribute Details

#calendar_period ⇒ ::Google::Type::CalendarPeriod

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#display_name ⇒ ::String

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#goal ⇒ ::Float

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#name ⇒ ::String

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#rolling_period ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#service_level_indicator ⇒ ::Google::Cloud::Monitoring::V3::ServiceLevelIndicator

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

# File 'proto_docs/google/monitoring/v3/service.rb', line 396

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ServiceLevelObjective.View` determines what form of
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
  module View
    # Same as FULL.
    VIEW_UNSPECIFIED = 0

    # Return the embedded `ServiceLevelIndicator` in the form in which it was
    # defined. If it was defined using a `BasicSli`, return that `BasicSli`.
    FULL = 2

    # For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
    # return the `ServiceLevelIndicator` with its mode of computation fully
    # spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
    # `RequestBasedSli` or `WindowsBasedSli`, return the
    # `ServiceLevelIndicator` as it was provided.
    EXPLICIT = 1
  end
end