Class ServiceLevelObjective.Builder (3.52.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ServiceLevelObjective.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ServiceLevelObjective.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ServiceLevelObjective.Builder
Overrides

build()

public ServiceLevelObjective build()
Returns
Type Description
ServiceLevelObjective

buildPartial()

public ServiceLevelObjective buildPartial()
Returns
Type Description
ServiceLevelObjective

clear()

public ServiceLevelObjective.Builder clear()
Returns
Type Description
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
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

clearDisplayName()

public ServiceLevelObjective.Builder clearDisplayName()

Name used for UI elements listing this SLO.

string display_name = 11;

Returns
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ServiceLevelObjective.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

clearName()

public ServiceLevelObjective.Builder clearName()

Identifier. Resource name for this ServiceLevelObjective. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ServiceLevelObjective.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ServiceLevelObjective.Builder
Overrides

clearPeriod()

public ServiceLevelObjective.Builder clearPeriod()
Returns
Type Description
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
Type Description
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
Type Description
ServiceLevelObjective.Builder

clearUserLabels()

public ServiceLevelObjective.Builder clearUserLabels()
Returns
Type Description
ServiceLevelObjective.Builder

clone()

public ServiceLevelObjective.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for calendarPeriod.

getDefaultInstanceForType()

public ServiceLevelObjective getDefaultInstanceForType()
Returns
Type Description
ServiceLevelObjective

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Name used for UI elements listing this SLO.

string display_name = 11;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Name used for UI elements listing this SLO.

string display_name = 11;

Returns
Type Description
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
Type Description
double

The goal.

getMutableUserLabels() (deprecated)

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Identifier. Resource name for this ServiceLevelObjective. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name for this ServiceLevelObjective. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPeriodCase()

public ServiceLevelObjective.PeriodCase getPeriodCase()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ServiceLevelIndicatorOrBuilder

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the serviceLevelIndicator field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ServiceLevelObjective other)

public ServiceLevelObjective.Builder mergeFrom(ServiceLevelObjective other)
Parameter
Name Description
other ServiceLevelObjective
Returns
Type Description
ServiceLevelObjective.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ServiceLevelObjective.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceLevelObjective.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ServiceLevelObjective.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
value ServiceLevelIndicator
Returns
Type Description
ServiceLevelObjective.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ServiceLevelObjective.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
values Map<String,String>
Returns
Type Description
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
Name Description
key String
value String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Name Description
value com.google.type.CalendarPeriod

The calendarPeriod to set.
Returns
Type Description
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
Name Description
value int

The enum numeric value on the wire for calendarPeriod to set.
Returns
Type Description
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
Name Description
value String

The displayName to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ServiceLevelObjective.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value double

The goal to set.
Returns
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

setName(String value)

public ServiceLevelObjective.Builder setName(String value)

Identifier. Resource name for this ServiceLevelObjective. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ServiceLevelObjective.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ServiceLevelObjective.Builder setNameBytes(ByteString value)

Identifier. Resource name for this ServiceLevelObjective. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value ServiceLevelIndicator
Returns
Type Description
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
Name Description
builderForValue ServiceLevelIndicator.Builder
Returns
Type Description
ServiceLevelObjective.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ServiceLevelObjective.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ServiceLevelObjective.Builder
Overrides