Class ServiceLevelObjective (2.21.0)

ServiceLevelObjective(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
Identifier. Resource name for this ServiceLevelObjective. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
display_name str
Name used for UI elements listing this SLO.
service_level_indicator google.cloud.monitoring_v3.types.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.
goal float
The fraction of service that must be good in order for this objective to be met. 0 < goal=""><=>.
rolling_period google.protobuf.duration_pb2.Duration
A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days. This field is a member of oneof_ period.
calendar_period google.type.calendar_period_pb2.CalendarPeriod
A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. This field is a member of oneof_ period.
user_labels MutableMapping[str, str]
Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

Classes

UserLabelsEntry

UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

View

View(value)

ServiceLevelObjective.View determines what form of ServiceLevelObjective is returned from GetServiceLevelObjective, ListServiceLevelObjectives, and ListServiceLevelObjectiveVersions RPCs.

Values: VIEW_UNSPECIFIED (0): Same as FULL. FULL (2): Return the embedded ServiceLevelIndicator in the form in which it was defined. If it was defined using a BasicSli, return that BasicSli. EXPLICIT (1): 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.