com.google.api.services.monitoring.v3.model

Class ServiceLevelObjective

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.ServiceLevelObjective

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ServiceLevelObjective
extends com.google.api.client.json.GenericJson

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 is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ServiceLevelObjective()

Method Summary

Modifier and Type	Method and Description
ServiceLevelObjective	clone()
String	getCalendarPeriod() A calendar period, semantically "since the start of the current ".
String	getDisplayName() Name used for UI elements listing this SLO.
Double	getGoal() The fraction of service that must be good in order for this objective to be met.
String	getName() Identifier.
String	getRollingPeriod() A rolling time period, semantically "in the past ".
ServiceLevelIndicator	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.
Map<String,String>	getUserLabels() Labels which have been used to annotate the service-level objective.
ServiceLevelObjective	set(String fieldName, Object value)
ServiceLevelObjective	setCalendarPeriod(String calendarPeriod) A calendar period, semantically "since the start of the current ".
ServiceLevelObjective	setDisplayName(String displayName) Name used for UI elements listing this SLO.
ServiceLevelObjective	setGoal(Double goal) The fraction of service that must be good in order for this objective to be met.
ServiceLevelObjective	setName(String name) Identifier.
ServiceLevelObjective	setRollingPeriod(String rollingPeriod) A rolling time period, semantically "in the past ".
ServiceLevelObjective	setServiceLevelIndicator(ServiceLevelIndicator 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.
ServiceLevelObjective	setUserLabels(Map<String,String> userLabels) Labels which have been used to annotate the service-level objective.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ServiceLevelObjective

public ServiceLevelObjective()

Method Detail

getCalendarPeriod

public String getCalendarPeriod()

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

Returns:

value or null for none

setCalendarPeriod

public ServiceLevelObjective setCalendarPeriod(String calendarPeriod)

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

Parameters:

calendarPeriod - calendarPeriod or null for none

getDisplayName

public String getDisplayName()

Name used for UI elements listing this SLO.

Returns:

value or null for none

setDisplayName

public ServiceLevelObjective setDisplayName(String displayName)

Name used for UI elements listing this SLO.

Parameters:

displayName - displayName or null for none

getGoal

public Double getGoal()

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

Returns:

value or null for none

setGoal

public ServiceLevelObjective setGoal(Double goal)

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

Parameters:

goal - goal or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public ServiceLevelObjective setName(String name)

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

Parameters:

name - name or null for none

getRollingPeriod

public String getRollingPeriod()

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

Returns:

value or null for none

setRollingPeriod

public ServiceLevelObjective setRollingPeriod(String rollingPeriod)

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

Parameters:

rollingPeriod - rollingPeriod or null for none

getServiceLevelIndicator

public ServiceLevelIndicator 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:

value or null for none

setServiceLevelIndicator

public ServiceLevelObjective setServiceLevelIndicator(ServiceLevelIndicator 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.

Parameters:

serviceLevelIndicator - serviceLevelIndicator or null for none

getUserLabels

public Map<String,String> 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:

value or null for none

setUserLabels

public ServiceLevelObjective setUserLabels(Map<String,String> userLabels)

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.

Parameters:

userLabels - userLabels or null for none

set

public ServiceLevelObjective set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ServiceLevelObjective clone()

Overrides:

clone in class com.google.api.client.json.GenericJson