public final class ServiceLevelObjective extends GeneratedMessageV3 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 Fields
CALENDAR_PERIOD_FIELD_NUMBER
public static final int CALENDAR_PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GOAL_FIELD_NUMBER
public static final int GOAL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ROLLING_PERIOD_FIELD_NUMBER
public static final int ROLLING_PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_LEVEL_INDICATOR_FIELD_NUMBER
public static final int SERVICE_LEVEL_INDICATOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ServiceLevelObjective getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ServiceLevelObjective.Builder newBuilder()
newBuilder(ServiceLevelObjective prototype)
public static ServiceLevelObjective.Builder newBuilder(ServiceLevelObjective prototype)
public static ServiceLevelObjective parseDelimitedFrom(InputStream input)
public static ServiceLevelObjective parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ServiceLevelObjective parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ServiceLevelObjective parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ServiceLevelObjective parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ServiceLevelObjective parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ServiceLevelObjective parseFrom(CodedInputStream input)
public static ServiceLevelObjective parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ServiceLevelObjective parseFrom(InputStream input)
public static ServiceLevelObjective parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ServiceLevelObjective parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ServiceLevelObjective parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ServiceLevelObjective> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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()
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()
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.
|
getName()
Resource name for this ServiceLevelObjective. The format is:
projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
string name = 1;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<ServiceLevelObjective> getParserForType()
Overrides
getPeriodCase()
public ServiceLevelObjective.PeriodCase getPeriodCase()
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.
|
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserLabels()
public Map<String,String> getUserLabels()
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;
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;
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
|
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ServiceLevelObjective.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ServiceLevelObjective.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ServiceLevelObjective.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
