Class BasicSli (3.56.0)

public final class BasicSli extends GeneratedMessageV3 implements BasicSliOrBuilder

An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.

Protobuf type google.monitoring.v3.BasicSli

Implements

BasicSliOrBuilder

Static Fields

AVAILABILITY_FIELD_NUMBER

public static final int AVAILABILITY_FIELD_NUMBER
Field Value
Type Description
int

LATENCY_FIELD_NUMBER

public static final int LATENCY_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

METHOD_FIELD_NUMBER

public static final int METHOD_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BasicSli getDefaultInstance()
Returns
Type Description
BasicSli

getDescriptor()

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

newBuilder()

public static BasicSli.Builder newBuilder()
Returns
Type Description
BasicSli.Builder

newBuilder(BasicSli prototype)

public static BasicSli.Builder newBuilder(BasicSli prototype)
Parameter
Name Description
prototype BasicSli
Returns
Type Description
BasicSli.Builder

parseDelimitedFrom(InputStream input)

public static BasicSli parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BasicSli
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BasicSli
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BasicSli parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BasicSli
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BasicSli
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BasicSli parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BasicSli
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BasicSli
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BasicSli parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BasicSli
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BasicSli
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BasicSli parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BasicSli
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BasicSli
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BasicSli parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BasicSli
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BasicSli
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BasicSli> parser()
Returns
Type Description
Parser<BasicSli>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAvailability()

public BasicSli.AvailabilityCriteria getAvailability()

Good service is defined to be the count of requests made to this service that return successfully.

.google.monitoring.v3.BasicSli.AvailabilityCriteria availability = 2;

Returns
Type Description
BasicSli.AvailabilityCriteria

The availability.

getAvailabilityOrBuilder()

public BasicSli.AvailabilityCriteriaOrBuilder getAvailabilityOrBuilder()

Good service is defined to be the count of requests made to this service that return successfully.

.google.monitoring.v3.BasicSli.AvailabilityCriteria availability = 2;

Returns
Type Description
BasicSli.AvailabilityCriteriaOrBuilder

getDefaultInstanceForType()

public BasicSli getDefaultInstanceForType()
Returns
Type Description
BasicSli

getLatency()

public BasicSli.LatencyCriteria getLatency()

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

.google.monitoring.v3.BasicSli.LatencyCriteria latency = 3;

Returns
Type Description
BasicSli.LatencyCriteria

The latency.

getLatencyOrBuilder()

public BasicSli.LatencyCriteriaOrBuilder getLatencyOrBuilder()

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

.google.monitoring.v3.BasicSli.LatencyCriteria latency = 3;

Returns
Type Description
BasicSli.LatencyCriteriaOrBuilder

getLocation(int index)

public String getLocation(int index)

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

repeated string location = 8;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The location at the given index.

getLocationBytes(int index)

public ByteString getLocationBytes(int index)

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

repeated string location = 8;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the location at the given index.

getLocationCount()

public int getLocationCount()

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

repeated string location = 8;

Returns
Type Description
int

The count of location.

getLocationList()

public ProtocolStringList getLocationList()

OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.

repeated string location = 8;

Returns
Type Description
ProtocolStringList

A list containing the location.

getMethod(int index)

public String getMethod(int index)

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

repeated string method = 7;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The method at the given index.

getMethodBytes(int index)

public ByteString getMethodBytes(int index)

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

repeated string method = 7;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the method at the given index.

getMethodCount()

public int getMethodCount()

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

repeated string method = 7;

Returns
Type Description
int

The count of method.

getMethodList()

public ProtocolStringList getMethodList()

OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.

repeated string method = 7;

Returns
Type Description
ProtocolStringList

A list containing the method.

getParserForType()

public Parser<BasicSli> getParserForType()
Returns
Type Description
Parser<BasicSli>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSliCriteriaCase()

public BasicSli.SliCriteriaCase getSliCriteriaCase()
Returns
Type Description
BasicSli.SliCriteriaCase

getVersion(int index)

public String getVersion(int index)

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

repeated string version = 9;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The version at the given index.

getVersionBytes(int index)

public ByteString getVersionBytes(int index)

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

repeated string version = 9;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the version at the given index.

getVersionCount()

public int getVersionCount()

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

repeated string version = 9;

Returns
Type Description
int

The count of version.

getVersionList()

public ProtocolStringList getVersionList()

OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.

repeated string version = 9;

Returns
Type Description
ProtocolStringList

A list containing the version.

hasAvailability()

public boolean hasAvailability()

Good service is defined to be the count of requests made to this service that return successfully.

.google.monitoring.v3.BasicSli.AvailabilityCriteria availability = 2;

Returns
Type Description
boolean

Whether the availability field is set.

hasLatency()

public boolean hasLatency()

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

.google.monitoring.v3.BasicSli.LatencyCriteria latency = 3;

Returns
Type Description
boolean

Whether the latency field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BasicSli.Builder newBuilderForType()
Returns
Type Description
BasicSli.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BasicSli.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BasicSli.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BasicSli.Builder toBuilder()
Returns
Type Description
BasicSli.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException