Class BasicSli (3.20.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
TypeDescription
int

LATENCY_FIELD_NUMBER

public static final int LATENCY_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

METHOD_FIELD_NUMBER

public static final int METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BasicSli getDefaultInstance()
Returns
TypeDescription
BasicSli

getDescriptor()

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

newBuilder()

public static BasicSli.Builder newBuilder()
Returns
TypeDescription
BasicSli.Builder

newBuilder(BasicSli prototype)

public static BasicSli.Builder newBuilder(BasicSli prototype)
Parameter
NameDescription
prototypeBasicSli
Returns
TypeDescription
BasicSli.Builder

parseDelimitedFrom(InputStream input)

public static BasicSli parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BasicSli parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BasicSli parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BasicSli parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BasicSli parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BasicSli parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BasicSli parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BasicSli
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BasicSli> parser()
Returns
TypeDescription
Parser<BasicSli>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
BasicSli.AvailabilityCriteriaOrBuilder

getDefaultInstanceForType()

public BasicSli getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the method.

getParserForType()

public Parser<BasicSli> getParserForType()
Returns
TypeDescription
Parser<BasicSli>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSliCriteriaCase()

public BasicSli.SliCriteriaCase getSliCriteriaCase()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the latency field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BasicSli.Builder newBuilderForType()
Returns
TypeDescription
BasicSli.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BasicSli.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BasicSli.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BasicSli.Builder toBuilder()
Returns
TypeDescription
BasicSli.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException