java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.config.filter.http.cache.v2alpha.CacheConfig.KeyCreatorParams

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CacheConfig.KeyCreatorParamsOrBuilder, Serializable

Enclosing class:

CacheConfig
```
public static final class CacheConfig.KeyCreatorParams
extends com.google.protobuf.GeneratedMessageV3
implements CacheConfig.KeyCreatorParamsOrBuilder
```
```
 [#not-implemented-hide:]
 Modifies cache key creation by restricting which parts of the URL are included.
 
```
Protobuf type envoy.config.filter.http.cache.v2alpha.CacheConfig.KeyCreatorParams
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CacheConfig.KeyCreatorParams.Builder`	[#not-implemented-hide:] Modifies cache key creation by restricting which parts of the URL are included.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

Fields
Modifier and Type	Field	Description
`static int`	`EXCLUDE_HOST_FIELD_NUMBER`
`static int`	`EXCLUDE_SCHEME_FIELD_NUMBER`
`static int`	`QUERY_PARAMETERS_EXCLUDED_FIELD_NUMBER`
`static int`	`QUERY_PARAMETERS_INCLUDED_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`static CacheConfig.KeyCreatorParams`	`getDefaultInstance()`
`CacheConfig.KeyCreatorParams`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`boolean`	`getExcludeHost()`	If true, exclude the host from the cache key.
`boolean`	`getExcludeScheme()`	If true, exclude the URL scheme from the cache key.
`com.google.protobuf.Parser<CacheConfig.KeyCreatorParams>`	`getParserForType()`
`QueryParameterMatcher`	`getQueryParametersExcluded(int index)`	If query_parameters_excluded is nonempty, query parameters matched by one or more of its matchers are excluded from the cache key (even if also matched by query_parameters_included), and will not affect cache lookup.
`int`	`getQueryParametersExcludedCount()`	If query_parameters_excluded is nonempty, query parameters matched by one or more of its matchers are excluded from the cache key (even if also matched by query_parameters_included), and will not affect cache lookup.
`List<QueryParameterMatcher>`	`getQueryParametersExcludedList()`	If query_parameters_excluded is nonempty, query parameters matched by one or more of its matchers are excluded from the cache key (even if also matched by query_parameters_included), and will not affect cache lookup.
`QueryParameterMatcherOrBuilder`	`getQueryParametersExcludedOrBuilder(int index)`	If query_parameters_excluded is nonempty, query parameters matched by one or more of its matchers are excluded from the cache key (even if also matched by query_parameters_included), and will not affect cache lookup.
`List<? extends QueryParameterMatcherOrBuilder>`	`getQueryParametersExcludedOrBuilderList()`	If query_parameters_excluded is nonempty, query parameters matched by one or more of its matchers are excluded from the cache key (even if also matched by query_parameters_included), and will not affect cache lookup.
`QueryParameterMatcher`	`getQueryParametersIncluded(int index)`	If query_parameters_included is nonempty, only query parameters matched by one or more of its matchers are included in the cache key.
`int`	`getQueryParametersIncludedCount()`	If query_parameters_included is nonempty, only query parameters matched by one or more of its matchers are included in the cache key.
`List<QueryParameterMatcher>`	`getQueryParametersIncludedList()`	If query_parameters_included is nonempty, only query parameters matched by one or more of its matchers are included in the cache key.
`QueryParameterMatcherOrBuilder`	`getQueryParametersIncludedOrBuilder(int index)`	If query_parameters_included is nonempty, only query parameters matched by one or more of its matchers are included in the cache key.
`List<? extends QueryParameterMatcherOrBuilder>`	`getQueryParametersIncludedOrBuilderList()`	If query_parameters_included is nonempty, only query parameters matched by one or more of its matchers are included in the cache key.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static CacheConfig.KeyCreatorParams.Builder`	`newBuilder()`
`static CacheConfig.KeyCreatorParams.Builder`	`newBuilder(CacheConfig.KeyCreatorParams prototype)`
`CacheConfig.KeyCreatorParams.Builder`	`newBuilderForType()`
`protected CacheConfig.KeyCreatorParams.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static CacheConfig.KeyCreatorParams`	`parseDelimitedFrom(InputStream input)`
`static CacheConfig.KeyCreatorParams`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(byte[] data)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(com.google.protobuf.ByteString data)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(InputStream input)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(ByteBuffer data)`
`static CacheConfig.KeyCreatorParams`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<CacheConfig.KeyCreatorParams>`	`parser()`
`CacheConfig.KeyCreatorParams.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail
- EXCLUDE_SCHEME_FIELD_NUMBER
```
public static final int EXCLUDE_SCHEME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXCLUDE_HOST_FIELD_NUMBER
```
public static final int EXCLUDE_HOST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_PARAMETERS_INCLUDED_FIELD_NUMBER
```
public static final int QUERY_PARAMETERS_INCLUDED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_PARAMETERS_EXCLUDED_FIELD_NUMBER
```
public static final int QUERY_PARAMETERS_EXCLUDED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getExcludeScheme

public boolean getExcludeScheme()

 If true, exclude the URL scheme from the cache key. Set to true if your origins always
 produce the same response for http and https requests.

bool exclude_scheme = 1;

Specified by:: getExcludeScheme in interface CacheConfig.KeyCreatorParamsOrBuilder
Returns:: The excludeScheme.

getExcludeHost

public boolean getExcludeHost()

 If true, exclude the host from the cache key. Set to true if your origins' responses don't
 ever depend on host.

bool exclude_host = 2;

Specified by:: getExcludeHost in interface CacheConfig.KeyCreatorParamsOrBuilder
Returns:: The excludeHost.

getQueryParametersIncludedList

public List<QueryParameterMatcher> getQueryParametersIncludedList()

 If *query_parameters_included* is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.

repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

Specified by:: getQueryParametersIncludedList in interface CacheConfig.KeyCreatorParamsOrBuilder

getQueryParametersIncludedOrBuilderList

public List<? extends QueryParameterMatcherOrBuilder> getQueryParametersIncludedOrBuilderList()

 If *query_parameters_included* is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.

repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

Specified by:: getQueryParametersIncludedOrBuilderList in interface CacheConfig.KeyCreatorParamsOrBuilder

getQueryParametersIncludedCount

public int getQueryParametersIncludedCount()

 If *query_parameters_included* is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.

repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

Specified by:: getQueryParametersIncludedCount in interface CacheConfig.KeyCreatorParamsOrBuilder

getQueryParametersIncluded

public QueryParameterMatcher getQueryParametersIncluded(int index)

 If *query_parameters_included* is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.

repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

Specified by:: getQueryParametersIncluded in interface CacheConfig.KeyCreatorParamsOrBuilder

getQueryParametersIncludedOrBuilder

public QueryParameterMatcherOrBuilder getQueryParametersIncludedOrBuilder(int index)

 If *query_parameters_included* is nonempty, only query parameters matched
 by one or more of its matchers are included in the cache key. Any other
 query params will not affect cache lookup.

repeated .envoy.api.v2.route.QueryParameterMatcher query_parameters_included = 3;

Specified by:: getQueryParametersIncludedOrBuilder in interface CacheConfig.KeyCreatorParamsOrBuilder