Class ServiceLevelObjective.Builder (3.3.0)

public static final class ServiceLevelObjective.Builder extends GeneratedMessageV3.Builder<ServiceLevelObjective.Builder> implements ServiceLevelObjectiveOrBuilder

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

Protobuf type google.monitoring.v3.ServiceLevelObjective

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ServiceLevelObjective.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

build()

public ServiceLevelObjective build()
Returns
TypeDescription
ServiceLevelObjective

buildPartial()

public ServiceLevelObjective buildPartial()
Returns
TypeDescription
ServiceLevelObjective

clear()

public ServiceLevelObjective.Builder clear()
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

clearCalendarPeriod()

public ServiceLevelObjective.Builder clearCalendarPeriod()

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

.google.type.CalendarPeriod calendar_period = 6;

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

clearDisplayName()

public ServiceLevelObjective.Builder clearDisplayName()

Name used for UI elements listing this SLO.

string display_name = 11;

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ServiceLevelObjective.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

clearGoal()

public ServiceLevelObjective.Builder clearGoal()

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

double goal = 4;

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

clearName()

public ServiceLevelObjective.Builder clearName()

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

string name = 1;

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ServiceLevelObjective.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

clearPeriod()

public ServiceLevelObjective.Builder clearPeriod()
Returns
TypeDescription
ServiceLevelObjective.Builder

clearRollingPeriod()

public ServiceLevelObjective.Builder clearRollingPeriod()

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

.google.protobuf.Duration rolling_period = 5;

Returns
TypeDescription
ServiceLevelObjective.Builder

clearServiceLevelIndicator()

public ServiceLevelObjective.Builder clearServiceLevelIndicator()

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Returns
TypeDescription
ServiceLevelObjective.Builder

clearUserLabels()

public ServiceLevelObjective.Builder clearUserLabels()
Returns
TypeDescription
ServiceLevelObjective.Builder

clone()

public ServiceLevelObjective.Builder clone()
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

containsUserLabels(String key)

public boolean containsUserLabels(String key)

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.

map<string, string> user_labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCalendarPeriod()

public CalendarPeriod getCalendarPeriod()

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

.google.type.CalendarPeriod calendar_period = 6;

Returns
TypeDescription
com.google.type.CalendarPeriod

The calendarPeriod.

getCalendarPeriodValue()

public int getCalendarPeriodValue()

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

.google.type.CalendarPeriod calendar_period = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for calendarPeriod.

getDefaultInstanceForType()

public ServiceLevelObjective getDefaultInstanceForType()
Returns
TypeDescription
ServiceLevelObjective

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Name used for UI elements listing this SLO.

string display_name = 11;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Name used for UI elements listing this SLO.

string display_name = 11;

Returns
TypeDescription
ByteString

The bytes for displayName.

getGoal()

public double getGoal()

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

double goal = 4;

Returns
TypeDescription
double

The goal.

getMutableUserLabels()

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getPeriodCase()

public ServiceLevelObjective.PeriodCase getPeriodCase()
Returns
TypeDescription
ServiceLevelObjective.PeriodCase

getRollingPeriod()

public Duration getRollingPeriod()

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

.google.protobuf.Duration rolling_period = 5;

Returns
TypeDescription
Duration

The rollingPeriod.

getRollingPeriodBuilder()

public Duration.Builder getRollingPeriodBuilder()

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

.google.protobuf.Duration rolling_period = 5;

Returns
TypeDescription
Builder

getRollingPeriodOrBuilder()

public DurationOrBuilder getRollingPeriodOrBuilder()

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

.google.protobuf.Duration rolling_period = 5;

Returns
TypeDescription
DurationOrBuilder

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Returns
TypeDescription
ServiceLevelIndicator

The serviceLevelIndicator.

getServiceLevelIndicatorBuilder()

public ServiceLevelIndicator.Builder getServiceLevelIndicatorBuilder()

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Returns
TypeDescription
ServiceLevelIndicator.Builder

getServiceLevelIndicatorOrBuilder()

public ServiceLevelIndicatorOrBuilder getServiceLevelIndicatorOrBuilder()

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Returns
TypeDescription
ServiceLevelIndicatorOrBuilder

getUserLabels()

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

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.

map<string, string> user_labels = 12;

Returns
TypeDescription
int

getUserLabelsMap()

public Map<String,String> getUserLabelsMap()

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.

map<string, string> user_labels = 12;

Returns
TypeDescription
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> user_labels = 12;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(String key)

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.

map<string, string> user_labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

hasCalendarPeriod()

public boolean hasCalendarPeriod()

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

.google.type.CalendarPeriod calendar_period = 6;

Returns
TypeDescription
boolean

Whether the calendarPeriod field is set.

hasRollingPeriod()

public boolean hasRollingPeriod()

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

.google.protobuf.Duration rolling_period = 5;

Returns
TypeDescription
boolean

Whether the rollingPeriod field is set.

hasServiceLevelIndicator()

public boolean hasServiceLevelIndicator()

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Returns
TypeDescription
boolean

Whether the serviceLevelIndicator field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ServiceLevelObjective other)

public ServiceLevelObjective.Builder mergeFrom(ServiceLevelObjective other)
Parameter
NameDescription
otherServiceLevelObjective
Returns
TypeDescription
ServiceLevelObjective.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ServiceLevelObjective.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ServiceLevelObjective.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

mergeRollingPeriod(Duration value)

public ServiceLevelObjective.Builder mergeRollingPeriod(Duration value)

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

.google.protobuf.Duration rolling_period = 5;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ServiceLevelObjective.Builder

mergeServiceLevelIndicator(ServiceLevelIndicator value)

public ServiceLevelObjective.Builder mergeServiceLevelIndicator(ServiceLevelIndicator value)

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Parameter
NameDescription
valueServiceLevelIndicator
Returns
TypeDescription
ServiceLevelObjective.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ServiceLevelObjective.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

putAllUserLabels(Map<String,String> values)

public ServiceLevelObjective.Builder putAllUserLabels(Map<String,String> values)

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.

map<string, string> user_labels = 12;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
ServiceLevelObjective.Builder

putUserLabels(String key, String value)

public ServiceLevelObjective.Builder putUserLabels(String key, String value)

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.

map<string, string> user_labels = 12;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
ServiceLevelObjective.Builder

removeUserLabels(String key)

public ServiceLevelObjective.Builder removeUserLabels(String key)

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.

map<string, string> user_labels = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
ServiceLevelObjective.Builder

setCalendarPeriod(CalendarPeriod value)

public ServiceLevelObjective.Builder setCalendarPeriod(CalendarPeriod value)

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

.google.type.CalendarPeriod calendar_period = 6;

Parameter
NameDescription
valuecom.google.type.CalendarPeriod

The calendarPeriod to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setCalendarPeriodValue(int value)

public ServiceLevelObjective.Builder setCalendarPeriodValue(int value)

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

.google.type.CalendarPeriod calendar_period = 6;

Parameter
NameDescription
valueint

The enum numeric value on the wire for calendarPeriod to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setDisplayName(String value)

public ServiceLevelObjective.Builder setDisplayName(String value)

Name used for UI elements listing this SLO.

string display_name = 11;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ServiceLevelObjective.Builder setDisplayNameBytes(ByteString value)

Name used for UI elements listing this SLO.

string display_name = 11;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ServiceLevelObjective.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

setGoal(double value)

public ServiceLevelObjective.Builder setGoal(double value)

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

double goal = 4;

Parameter
NameDescription
valuedouble

The goal to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setName(String value)

public ServiceLevelObjective.Builder setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ServiceLevelObjective.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ServiceLevelObjective.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ServiceLevelObjective.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides

setRollingPeriod(Duration value)

public ServiceLevelObjective.Builder setRollingPeriod(Duration value)

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

.google.protobuf.Duration rolling_period = 5;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ServiceLevelObjective.Builder

setRollingPeriod(Duration.Builder builderForValue)

public ServiceLevelObjective.Builder setRollingPeriod(Duration.Builder builderForValue)

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

.google.protobuf.Duration rolling_period = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ServiceLevelObjective.Builder

setServiceLevelIndicator(ServiceLevelIndicator value)

public ServiceLevelObjective.Builder setServiceLevelIndicator(ServiceLevelIndicator value)

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Parameter
NameDescription
valueServiceLevelIndicator
Returns
TypeDescription
ServiceLevelObjective.Builder

setServiceLevelIndicator(ServiceLevelIndicator.Builder builderForValue)

public ServiceLevelObjective.Builder setServiceLevelIndicator(ServiceLevelIndicator.Builder builderForValue)

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.

.google.monitoring.v3.ServiceLevelIndicator service_level_indicator = 3;

Parameter
NameDescription
builderForValueServiceLevelIndicator.Builder
Returns
TypeDescription
ServiceLevelObjective.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ServiceLevelObjective.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ServiceLevelObjective.Builder
Overrides