target.apidocs.com.google.api.services.compute.model.BackendServiceCustomMetric.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

The newest version!







BackendServiceCustomMetric (Compute Engine API v1-rev20250320-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class BackendServiceCustomMetric



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.BackendServiceCustomMetric













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class BackendServiceCustomMetric
extends com.google.api.client.json.GenericJson
Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


BackendServiceCustomMetric() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BackendServiceCustomMetric
clone() 


Boolean
getDryRun()
If true, the metric data is not used for load balancing.



String
getName()
Name of a custom utilization signal.



BackendServiceCustomMetric
set(String fieldName,
   Object value) 


BackendServiceCustomMetric
setDryRun(Boolean dryRun)
If true, the metric data is not used for load balancing.



BackendServiceCustomMetric
setName(String name)
Name of a custom utilization signal.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





BackendServiceCustomMetric
public BackendServiceCustomMetric()









Method Detail





getDryRun
public Boolean getDryRun()
If true, the metric data is not used for load balancing.

Returns:
value or null for none








setDryRun
public BackendServiceCustomMetric setDryRun(Boolean dryRun)
If true, the metric data is not used for load balancing.

Parameters:
dryRun - dryRun or null for none








getName
public String getName()
Name of a custom utilization signal. The name must be 1-64 characters long and match the
 regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a
 lowercase letter, and all following characters must be a dash, period, underscore, lowercase
 letter, or digit, except the last character, which cannot be a dash, period, or underscore. For
 usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global
 or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED,
 INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

Returns:
value or null for none








setName
public BackendServiceCustomMetric setName(String name)
Name of a custom utilization signal. The name must be 1-64 characters long and match the
 regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a
 lowercase letter, and all following characters must be a dash, period, underscore, lowercase
 letter, or digit, except the last character, which cannot be a dash, period, or underscore. For
 usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global
 or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED,
 INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

Parameters:
name - name or null for none








set
public BackendServiceCustomMetric set(String fieldName,
                                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public BackendServiceCustomMetric clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`BackendServiceCustomMetric`	`clone()`
`Boolean`	`getDryRun()` If true, the metric data is not used for load balancing.
`String`	`getName()` Name of a custom utilization signal.
`BackendServiceCustomMetric`	`set(String fieldName, Object value)`
`BackendServiceCustomMetric`	`setDryRun(Boolean dryRun)` If true, the metric data is not used for load balancing.
`BackendServiceCustomMetric`	`setName(String name)` Name of a custom utilization signal.