Class Slo

A Service-Level Objective (SLO) describes the 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."

To get more information about Slo, see:

Inheritance

System.Object

Resource

CustomResource

Slo

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Monitoring

Assembly: Pulumi.Gcp.dll

Syntax

public class Slo : CustomResource

Constructors

View Source

Slo(String, SloArgs, CustomResourceOptions)

Create a Slo resource with the given unique name, arguments, and options.

Declaration

public Slo(string name, SloArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SloArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

BasicSli

Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below.

Declaration

public Output<SloBasicSli> BasicSli { get; }

Property Value

Type	Description
Output<SloBasicSli>

View Source

CalendarPeriod

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

Declaration

public Output<string> CalendarPeriod { get; }

Property Value

Type	Description
Output<System.String>

View Source

DisplayName

Name used for UI elements listing this SLO.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

View Source

Goal

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

Declaration

public Output<double> Goal { get; }

Property Value

Type	Description
Output<System.Double>

View Source

Name

The full resource name for this service. The syntax is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

RequestBasedSli

A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below.

Declaration

public Output<SloRequestBasedSli> RequestBasedSli { get; }

Property Value

Type	Description
Output<SloRequestBasedSli>

View Source

RollingPeriodDays

A rolling time period, semantically "in the past X days". Must be between 1 to 30 days, inclusive.

Declaration

public Output<int?> RollingPeriodDays { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

Service

ID of the service to which this SLO belongs.

Declaration

public Output<string> Service { get; }

Property Value

Type	Description
Output<System.String>

View Source

SloId

The id to use for this ServiceLevelObjective. If omitted, an id will be generated instead.

Declaration

public Output<string> SloId { get; }

Property Value

Type	Description
Output<System.String>

View Source

WindowsBasedSli

A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below.

Declaration

public Output<SloWindowsBasedSli> WindowsBasedSli { get; }

Property Value

Type	Description
Output<SloWindowsBasedSli>

Methods

View Source

Get(String, Input<String>, SloState, CustomResourceOptions)

Get an existing Slo resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Slo Get(string name, Input<string> id, SloState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SloState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Slo