Class Monitoring (2.39.0)

public final class Monitoring extends GeneratedMessageV3 implements MonitoringOrBuilder

Monitoring configuration of the service.

The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The library.googleapis.com/book/returned_count metric is sent to both producer and consumer projects, whereas the library.googleapis.com/book/num_overdue metric is only sent to the consumer project.

 monitored_resources:
 - type: library.googleapis.com/Branch
   display_name: "Library Branch"
   description: "A branch of a library."
   launch_stage: GA
   labels:
   - key: resource_container
     description: "The Cloud container (ie. project id) for the Branch."
   - key: location
     description: "The location of the library branch."
   - key: branch_id
     description: "The id of the branch."
 metrics:
 - name: library.googleapis.com/book/returned_count
   display_name: "Books Returned"
   description: "The count of books that have been returned."
   launch_stage: GA
   metric_kind: DELTA
   value_type: INT64
   unit: "1"
   labels:
   - key: customer_id
     description: "The id of the customer."
 - name: library.googleapis.com/book/num_overdue
   display_name: "Books Overdue"
   description: "The current number of overdue books."
   launch_stage: GA
   metric_kind: GAUGE
   value_type: INT64
   unit: "1"
   labels:
   - key: customer_id
     description: "The id of the customer."
 monitoring:
   producer_destinations:
   - monitored_resource: library.googleapis.com/Branch
     metrics:
     - library.googleapis.com/book/returned_count
   consumer_destinations:
   - monitored_resource: library.googleapis.com/Branch
     metrics:
     - library.googleapis.com/book/returned_count
     - library.googleapis.com/book/num_overdue

Protobuf type google.api.Monitoring

Implements

MonitoringOrBuilder

Static Fields

CONSUMER_DESTINATIONS_FIELD_NUMBER

public static final int CONSUMER_DESTINATIONS_FIELD_NUMBER
Field Value
Type Description
int

PRODUCER_DESTINATIONS_FIELD_NUMBER

public static final int PRODUCER_DESTINATIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Monitoring getDefaultInstance()
Returns
Type Description
Monitoring

getDescriptor()

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

newBuilder()

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

newBuilder(Monitoring prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getConsumerDestinations(int index)

public Monitoring.MonitoringDestination getConsumerDestinations(int index)

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination consumer_destinations = 2;

Parameter
Name Description
index int
Returns
Type Description
Monitoring.MonitoringDestination

getConsumerDestinationsCount()

public int getConsumerDestinationsCount()

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination consumer_destinations = 2;

Returns
Type Description
int

getConsumerDestinationsList()

public List<Monitoring.MonitoringDestination> getConsumerDestinationsList()

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination consumer_destinations = 2;

Returns
Type Description
List<MonitoringDestination>

getConsumerDestinationsOrBuilder(int index)

public Monitoring.MonitoringDestinationOrBuilder getConsumerDestinationsOrBuilder(int index)

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination consumer_destinations = 2;

Parameter
Name Description
index int
Returns
Type Description
Monitoring.MonitoringDestinationOrBuilder

getConsumerDestinationsOrBuilderList()

public List<? extends Monitoring.MonitoringDestinationOrBuilder> getConsumerDestinationsOrBuilderList()

Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination consumer_destinations = 2;

Returns
Type Description
List<? extends com.google.api.Monitoring.MonitoringDestinationOrBuilder>

getDefaultInstanceForType()

public Monitoring getDefaultInstanceForType()
Returns
Type Description
Monitoring

getParserForType()

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

getProducerDestinations(int index)

public Monitoring.MonitoringDestination getProducerDestinations(int index)

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination producer_destinations = 1;

Parameter
Name Description
index int
Returns
Type Description
Monitoring.MonitoringDestination

getProducerDestinationsCount()

public int getProducerDestinationsCount()

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination producer_destinations = 1;

Returns
Type Description
int

getProducerDestinationsList()

public List<Monitoring.MonitoringDestination> getProducerDestinationsList()

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination producer_destinations = 1;

Returns
Type Description
List<MonitoringDestination>

getProducerDestinationsOrBuilder(int index)

public Monitoring.MonitoringDestinationOrBuilder getProducerDestinationsOrBuilder(int index)

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination producer_destinations = 1;

Parameter
Name Description
index int
Returns
Type Description
Monitoring.MonitoringDestinationOrBuilder

getProducerDestinationsOrBuilderList()

public List<? extends Monitoring.MonitoringDestinationOrBuilder> getProducerDestinationsOrBuilderList()

Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

repeated .google.api.Monitoring.MonitoringDestination producer_destinations = 1;

Returns
Type Description
List<? extends com.google.api.Monitoring.MonitoringDestinationOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 Monitoring.Builder newBuilderForType()
Returns
Type Description
Monitoring.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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