Class MetadataFilter (1.37.0)

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

FILTER_LABELS_FIELD_NUMBER

public static final int FILTER_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_MATCH_CRITERIA_FIELD_NUMBER

public static final int FILTER_MATCH_CRITERIA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MetadataFilter getDefaultInstance()
Returns
TypeDescription
MetadataFilter

getDescriptor()

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

newBuilder()

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

newBuilder(MetadataFilter prototype)

public static MetadataFilter.Builder newBuilder(MetadataFilter prototype)
Parameter
NameDescription
prototypeMetadataFilter
Returns
TypeDescription
MetadataFilter.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public MetadataFilter getDefaultInstanceForType()
Returns
TypeDescription
MetadataFilter

getFilterLabels(int index)

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

getFilterLabelsCount()

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
TypeDescription
int

getFilterLabelsList()

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;

Returns
TypeDescription
List<MetadataFilterLabelMatch>

getFilterLabelsOrBuilder(int index)

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

getFilterLabelsOrBuilderList()

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
TypeDescription
List<? extends com.google.cloud.compute.v1.MetadataFilterLabelMatchOrBuilder>

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. Check the FilterMatchCriteria enum for the list of possible values.

optional string filter_match_criteria = 239970368;

Returns
TypeDescription
String

The filterMatchCriteria.

getFilterMatchCriteriaBytes()

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
TypeDescription
ByteString

The bytes for filterMatchCriteria.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasFilterMatchCriteria()

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

Whether the filterMatchCriteria 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 MetadataFilter.Builder newBuilderForType()
Returns
TypeDescription
MetadataFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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