com.google.api.services.compute.model

Class MetadataFilter

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.MetadataFilter

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MetadataFilter
extends com.google.api.client.json.GenericJson

Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.

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
MetadataFilter()

Method Summary

Modifier and Type	Method and Description
MetadataFilter	clone()
List<MetadataFilterLabelMatch>	getFilterLabels() The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
String	getFilterMatchCriteria() Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match.
MetadataFilter	set(String fieldName, Object value)
MetadataFilter	setFilterLabels(List<MetadataFilterLabelMatch> filterLabels) The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
MetadataFilter	setFilterMatchCriteria(String filterMatchCriteria) Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match.

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

MetadataFilter

public MetadataFilter()

Method Detail

getFilterLabels

public List<MetadataFilterLabelMatch> getFilterLabels()

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Returns:

value or null for none

setFilterLabels

public MetadataFilter setFilterLabels(List<MetadataFilterLabelMatch> filterLabels)

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Parameters:

filterLabels - filterLabels or null for none

getFilterMatchCriteria

public String getFilterMatchCriteria()

Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.

Returns:

value or null for none

setFilterMatchCriteria

public MetadataFilter setFilterMatchCriteria(String filterMatchCriteria)

Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.

Parameters:

filterMatchCriteria - filterMatchCriteria or null for none

set

public MetadataFilter set(String fieldName,
                          Object value)

Overrides:

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

clone

public MetadataFilter clone()

Overrides:

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