Class HeaderToMetadata.Rule
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.Rule
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,HeaderToMetadata.RuleOrBuilder,Serializable
- Enclosing class:
- HeaderToMetadata
public static final class HeaderToMetadata.Rule
extends com.google.protobuf.GeneratedMessageV3
implements HeaderToMetadata.RuleOrBuilder
A Rule defines what metadata to apply when a header is present or missing.Protobuf type
envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.Rule- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA Rule defines what metadata to apply when a header is present or missing.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic HeaderToMetadata.Rulestatic final com.google.protobuf.Descriptors.DescriptorSpecifies that a match will be performed on the value of a header.com.google.protobuf.ByteStringSpecifies that a match will be performed on the value of a header.If the header is not present, apply this metadata KeyValuePair.If the header is not present, apply this metadata KeyValuePair.If the header is present, apply this metadata KeyValuePair.If the header is present, apply this metadata KeyValuePair.com.google.protobuf.Parser<HeaderToMetadata.Rule>booleanWhether or not to remove the header after a rule is applied.intinthashCode()booleanIf the header is not present, apply this metadata KeyValuePair.booleanIf the header is present, apply this metadata KeyValuePair.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(HeaderToMetadata.Rule prototype) protected HeaderToMetadata.Rule.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static HeaderToMetadata.RuleparseDelimitedFrom(InputStream input) static HeaderToMetadata.RuleparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderToMetadata.RuleparseFrom(byte[] data) static HeaderToMetadata.RuleparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderToMetadata.RuleparseFrom(com.google.protobuf.ByteString data) static HeaderToMetadata.RuleparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderToMetadata.RuleparseFrom(com.google.protobuf.CodedInputStream input) static HeaderToMetadata.RuleparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderToMetadata.RuleparseFrom(InputStream input) static HeaderToMetadata.RuleparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderToMetadata.RuleparseFrom(ByteBuffer data) static HeaderToMetadata.RuleparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<HeaderToMetadata.Rule>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
HEADER_FIELD_NUMBER
public static final int HEADER_FIELD_NUMBER- See Also:
-
ON_PRESENT_FIELD_NUMBER
public static final int ON_PRESENT_FIELD_NUMBER- See Also:
-
ON_MISSING_FIELD_NUMBER
public static final int ON_MISSING_FIELD_NUMBER- See Also:
-
REMOVE_FIELD_NUMBER
public static final int REMOVE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getHeader
Specifies that a match will be performed on the value of a header. The header to be extracted.
string header = 1 [(.validate.rules) = { ... }- Specified by:
getHeaderin interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- The header.
-
getHeaderBytes
public com.google.protobuf.ByteString getHeaderBytes()Specifies that a match will be performed on the value of a header. The header to be extracted.
string header = 1 [(.validate.rules) = { ... }- Specified by:
getHeaderBytesin interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- The bytes for header.
-
hasOnPresent
public boolean hasOnPresent()If the header is present, apply this metadata KeyValuePair. If the value in the KeyValuePair is non-empty, it'll be used instead of the header value.
.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;- Specified by:
hasOnPresentin interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- Whether the onPresent field is set.
-
getOnPresent
If the header is present, apply this metadata KeyValuePair. If the value in the KeyValuePair is non-empty, it'll be used instead of the header value.
.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;- Specified by:
getOnPresentin interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- The onPresent.
-
getOnPresentOrBuilder
If the header is present, apply this metadata KeyValuePair. If the value in the KeyValuePair is non-empty, it'll be used instead of the header value.
.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;- Specified by:
getOnPresentOrBuilderin interfaceHeaderToMetadata.RuleOrBuilder
-
hasOnMissing
public boolean hasOnMissing()If the header is not present, apply this metadata KeyValuePair. The value in the KeyValuePair must be set, since it'll be used in lieu of the missing header value.
.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;- Specified by:
hasOnMissingin interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- Whether the onMissing field is set.
-
getOnMissing
If the header is not present, apply this metadata KeyValuePair. The value in the KeyValuePair must be set, since it'll be used in lieu of the missing header value.
.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;- Specified by:
getOnMissingin interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- The onMissing.
-
getOnMissingOrBuilder
If the header is not present, apply this metadata KeyValuePair. The value in the KeyValuePair must be set, since it'll be used in lieu of the missing header value.
.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;- Specified by:
getOnMissingOrBuilderin interfaceHeaderToMetadata.RuleOrBuilder
-
getRemove
public boolean getRemove()Whether or not to remove the header after a rule is applied. This prevents headers from leaking.
bool remove = 4;- Specified by:
getRemovein interfaceHeaderToMetadata.RuleOrBuilder- Returns:
- The remove.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HeaderToMetadata.Rule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static HeaderToMetadata.Rule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HeaderToMetadata.Rule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-