Stackdriver Monitoring V3 Client - Class ServiceLevelObjective (1.11.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ServiceLevelObjective.

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

Generated from protobuf message google.monitoring.v3.ServiceLevelObjective

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

↳ display_name string

Name used for UI elements listing this SLO.

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

↳ goal float

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.

↳ rolling_period Google\Protobuf\Duration

A rolling time period, semantically "in the past <rolling_period>". Must be an integer multiple of 1 day no larger than 30 days.

↳ calendar_period int

A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.

↳ user_labels array|Google\Protobuf\Internal\MapField

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.

getName

Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

Returns
Type Description
string

setName

Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Name used for UI elements listing this SLO.

Returns
Type Description
string

setDisplayName

Name used for UI elements listing this SLO.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceLevelIndicator

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.

Returns
Type Description
Google\Cloud\Monitoring\V3\ServiceLevelIndicator|null

hasServiceLevelIndicator

clearServiceLevelIndicator

setServiceLevelIndicator

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.

Parameter
Name Description
var Google\Cloud\Monitoring\V3\ServiceLevelIndicator
Returns
Type Description
$this

getGoal

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.

Returns
Type Description
float

setGoal

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.

Parameter
Name Description
var float
Returns
Type Description
$this

getRollingPeriod

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

Must be an integer multiple of 1 day no larger than 30 days.

Returns
Type Description
Google\Protobuf\Duration|null

hasRollingPeriod

setRollingPeriod

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

Must be an integer multiple of 1 day no larger than 30 days.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getCalendarPeriod

A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.

Returns
Type Description
int

hasCalendarPeriod

setCalendarPeriod

A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.

Parameter
Name Description
var int
Returns
Type Description
$this

getUserLabels

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setUserLabels

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getPeriod

Returns
Type Description
string