Stackdriver Monitoring V3 Client - Class BasicSli (1.5.1)

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

An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.

Generated from protobuf message google.monitoring.v3.BasicSli

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ method array

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

↳ location array

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

↳ version array

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

↳ availability Google\Cloud\Monitoring\V3\BasicSli\AvailabilityCriteria

Good service is defined to be the count of requests made to this service that return successfully.

↳ latency Google\Cloud\Monitoring\V3\BasicSli\LatencyCriteria

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

getMethod

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMethod

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getLocation

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setLocation

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getVersion

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setVersion

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getAvailability

Good service is defined to be the count of requests made to this service that return successfully.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\BasicSli\AvailabilityCriteria|null

hasAvailability

setAvailability

Good service is defined to be the count of requests made to this service that return successfully.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\BasicSli\AvailabilityCriteria
Returns
TypeDescription
$this

getLatency

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\BasicSli\LatencyCriteria|null

hasLatency

setLatency

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\BasicSli\LatencyCriteria
Returns
TypeDescription
$this

getSliCriteria

Returns
TypeDescription
string