public final class MetadataFilter extends GeneratedMessageV3 implements MetadataFilterOrBuilder
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.
Protobuf type google.cloud.compute.v1.MetadataFilter
Static Fields
public static final int FILTER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FILTER_MATCH_CRITERIA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static MetadataFilter getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static MetadataFilter.Builder newBuilder()
public static MetadataFilter.Builder newBuilder(MetadataFilter prototype)
public static MetadataFilter parseDelimitedFrom(InputStream input)
public static MetadataFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MetadataFilter parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static MetadataFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetadataFilter parseFrom(ByteString data)
public static MetadataFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetadataFilter parseFrom(CodedInputStream input)
public static MetadataFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static MetadataFilter parseFrom(InputStream input)
public static MetadataFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MetadataFilter parseFrom(ByteBuffer data)
public static MetadataFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<MetadataFilter> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public MetadataFilter getDefaultInstanceForType()
public MetadataFilterLabelMatch getFilterLabels(int index)
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.
repeated .google.cloud.compute.v1.MetadataFilterLabelMatch filter_labels = 307903142;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getFilterLabelsCount()
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.
repeated .google.cloud.compute.v1.MetadataFilterLabelMatch filter_labels = 307903142;
| Returns |
|---|
| Type | Description |
int | |
public List<MetadataFilterLabelMatch> getFilterLabelsList()
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.
repeated .google.cloud.compute.v1.MetadataFilterLabelMatch filter_labels = 307903142;
public MetadataFilterLabelMatchOrBuilder getFilterLabelsOrBuilder(int index)
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.
repeated .google.cloud.compute.v1.MetadataFilterLabelMatch filter_labels = 307903142;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends MetadataFilterLabelMatchOrBuilder> getFilterLabelsOrBuilderList()
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.
repeated .google.cloud.compute.v1.MetadataFilterLabelMatch filter_labels = 307903142;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.MetadataFilterLabelMatchOrBuilder> | |
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.
Check the FilterMatchCriteria enum for the list of possible values.
optional string filter_match_criteria = 239970368;
| Returns |
|---|
| Type | Description |
String | The filterMatchCriteria.
|
public ByteString getFilterMatchCriteriaBytes()
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.
Check the FilterMatchCriteria enum for the list of possible values.
optional string filter_match_criteria = 239970368;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filterMatchCriteria.
|
public Parser<MetadataFilter> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
public boolean hasFilterMatchCriteria()
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.
Check the FilterMatchCriteria enum for the list of possible values.
optional string filter_match_criteria = 239970368;
| Returns |
|---|
| Type | Description |
boolean | Whether the filterMatchCriteria field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public MetadataFilter.Builder newBuilderForType()
protected MetadataFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public MetadataFilter.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
