- 3.55.0 (latest)
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
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.BuilderImplements
ServiceLevelObjectiveOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ServiceLevelObjective.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ServiceLevelObjective.Builder |
build()
public ServiceLevelObjective build()
Type | Description |
ServiceLevelObjective |
buildPartial()
public ServiceLevelObjective buildPartial()
Type | Description |
ServiceLevelObjective |
clear()
public ServiceLevelObjective.Builder clear()
Type | Description |
ServiceLevelObjective.Builder |
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;
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;
Type | Description |
ServiceLevelObjective.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ServiceLevelObjective.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
ServiceLevelObjective.Builder |
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;
Type | Description |
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;
Type | Description |
ServiceLevelObjective.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ServiceLevelObjective.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
ServiceLevelObjective.Builder |
clearPeriod()
public ServiceLevelObjective.Builder clearPeriod()
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;
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;
Type | Description |
ServiceLevelObjective.Builder |
clearUserLabels()
public ServiceLevelObjective.Builder clearUserLabels()
Type | Description |
ServiceLevelObjective.Builder |
clone()
public ServiceLevelObjective.Builder clone()
Type | Description |
ServiceLevelObjective.Builder |
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;
Name | Description |
key | String |
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;
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;
Type | Description |
int | The enum numeric value on the wire for calendarPeriod. |
getDefaultInstanceForType()
public ServiceLevelObjective getDefaultInstanceForType()
Type | Description |
ServiceLevelObjective |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getDisplayName()
public String getDisplayName()
Name used for UI elements listing this SLO.
string display_name = 11;
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Name used for UI elements listing this SLO.
string display_name = 11;
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;
Type | Description |
double | The goal. |
getMutableUserLabels()
public Map<String,String> getMutableUserLabels()
Use alternate mutation accessors instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for name. |
getPeriodCase()
public ServiceLevelObjective.PeriodCase getPeriodCase()
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;
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;
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;
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;
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;
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;
Type | Description |
ServiceLevelIndicatorOrBuilder |
getUserLabels()
public Map<String,String> getUserLabels()
Use #getUserLabelsMap() instead.
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;
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;
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;
Name | Description |
key | String |
defaultValue | String |
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;
Name | Description |
key | String |
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;
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;
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;
Type | Description |
boolean | Whether the serviceLevelIndicator field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(ServiceLevelObjective other)
public ServiceLevelObjective.Builder mergeFrom(ServiceLevelObjective other)
Name | Description |
other | ServiceLevelObjective |
Type | Description |
ServiceLevelObjective.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ServiceLevelObjective.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ServiceLevelObjective.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public ServiceLevelObjective.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
ServiceLevelObjective.Builder |
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;
Name | Description |
value | Duration |
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;
Name | Description |
value | ServiceLevelIndicator |
Type | Description |
ServiceLevelObjective.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ServiceLevelObjective.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ServiceLevelObjective.Builder |
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;
Name | Description |
values | Map<String,String> |
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;
Name | Description |
key | String |
value | String |
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;
Name | Description |
key | String |
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;
Name | Description |
value | com.google.type.CalendarPeriod The calendarPeriod to set. |
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;
Name | Description |
value | int The enum numeric value on the wire for calendarPeriod to set. |
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;
Name | Description |
value | String The displayName to set. |
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;
Name | Description |
value | ByteString The bytes for displayName to set. |
Type | Description |
ServiceLevelObjective.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ServiceLevelObjective.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ServiceLevelObjective.Builder |
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;
Name | Description |
value | double The goal to set. |
Type | Description |
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;
Name | Description |
value | String The name to set. |
Type | Description |
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;
Name | Description |
value | ByteString The bytes for name to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
ServiceLevelObjective.Builder |
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;
Name | Description |
value | Duration |
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;
Name | Description |
builderForValue | Builder |
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;
Name | Description |
value | ServiceLevelIndicator |
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;
Name | Description |
builderForValue | ServiceLevelIndicator.Builder |
Type | Description |
ServiceLevelObjective.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ServiceLevelObjective.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ServiceLevelObjective.Builder |