OAuth2Config.Builder (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
    - - io.envoyproxy.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Config.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2ConfigOrBuilder, Cloneable

Enclosing class:

OAuth2Config
```
public static final class OAuth2Config.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
implements OAuth2ConfigOrBuilder
```
```
 OAuth config
 [#next-free-field: 9]
 
```
Protobuf type envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Config

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OAuth2Config.Builder`	`addAllPassThroughMatcher(Iterable<? extends HeaderMatcher> values)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`addPassThroughMatcher(HeaderMatcher.Builder builderForValue)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`addPassThroughMatcher(HeaderMatcher value)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`addPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`addPassThroughMatcher(int index, HeaderMatcher value)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`HeaderMatcher.Builder`	`addPassThroughMatcherBuilder()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`HeaderMatcher.Builder`	`addPassThroughMatcherBuilder(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`OAuth2Config`	`build()`
`OAuth2Config`	`buildPartial()`
`OAuth2Config.Builder`	`clear()`
`OAuth2Config.Builder`	`clearAuthorizationEndpoint()` The endpoint redirect to for authorization in response to unauthorized requests.
`OAuth2Config.Builder`	`clearCredentials()` Credentials used for OAuth.
`OAuth2Config.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`OAuth2Config.Builder`	`clearForwardBearerToken()` Forward the OAuth token as a Bearer to upstream web service.
`OAuth2Config.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`OAuth2Config.Builder`	`clearPassThroughMatcher()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`clearRedirectPathMatcher()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`OAuth2Config.Builder`	`clearRedirectUri()` The redirect URI passed to the authorization endpoint.
`OAuth2Config.Builder`	`clearSignoutPath()` The path to sign a user out, clearing their credential cookies.
`OAuth2Config.Builder`	`clearTokenEndpoint()` Endpoint on the authorization server to retrieve the access token from.
`OAuth2Config.Builder`	`clone()`
`String`	`getAuthorizationEndpoint()` The endpoint redirect to for authorization in response to unauthorized requests.
`com.google.protobuf.ByteString`	`getAuthorizationEndpointBytes()` The endpoint redirect to for authorization in response to unauthorized requests.
`OAuth2Credentials`	`getCredentials()` Credentials used for OAuth.
`OAuth2Credentials.Builder`	`getCredentialsBuilder()` Credentials used for OAuth.
`OAuth2CredentialsOrBuilder`	`getCredentialsOrBuilder()` Credentials used for OAuth.
`OAuth2Config`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getForwardBearerToken()` Forward the OAuth token as a Bearer to upstream web service.
`HeaderMatcher`	`getPassThroughMatcher(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`HeaderMatcher.Builder`	`getPassThroughMatcherBuilder(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`List<HeaderMatcher.Builder>`	`getPassThroughMatcherBuilderList()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`int`	`getPassThroughMatcherCount()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`List<HeaderMatcher>`	`getPassThroughMatcherList()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`HeaderMatcherOrBuilder`	`getPassThroughMatcherOrBuilder(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`List<? extends HeaderMatcherOrBuilder>`	`getPassThroughMatcherOrBuilderList()` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`PathMatcher`	`getRedirectPathMatcher()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`PathMatcher.Builder`	`getRedirectPathMatcherBuilder()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`PathMatcherOrBuilder`	`getRedirectPathMatcherOrBuilder()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`String`	`getRedirectUri()` The redirect URI passed to the authorization endpoint.
`com.google.protobuf.ByteString`	`getRedirectUriBytes()` The redirect URI passed to the authorization endpoint.
`PathMatcher`	`getSignoutPath()` The path to sign a user out, clearing their credential cookies.
`PathMatcher.Builder`	`getSignoutPathBuilder()` The path to sign a user out, clearing their credential cookies.
`PathMatcherOrBuilder`	`getSignoutPathOrBuilder()` The path to sign a user out, clearing their credential cookies.
`HttpUri`	`getTokenEndpoint()` Endpoint on the authorization server to retrieve the access token from.
`HttpUri.Builder`	`getTokenEndpointBuilder()` Endpoint on the authorization server to retrieve the access token from.
`HttpUriOrBuilder`	`getTokenEndpointOrBuilder()` Endpoint on the authorization server to retrieve the access token from.
`boolean`	`hasCredentials()` Credentials used for OAuth.
`boolean`	`hasRedirectPathMatcher()` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`boolean`	`hasSignoutPath()` The path to sign a user out, clearing their credential cookies.
`boolean`	`hasTokenEndpoint()` Endpoint on the authorization server to retrieve the access token from.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`OAuth2Config.Builder`	`mergeCredentials(OAuth2Credentials value)` Credentials used for OAuth.
`OAuth2Config.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`OAuth2Config.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`OAuth2Config.Builder`	`mergeFrom(OAuth2Config other)`
`OAuth2Config.Builder`	`mergeRedirectPathMatcher(PathMatcher value)` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`OAuth2Config.Builder`	`mergeSignoutPath(PathMatcher value)` The path to sign a user out, clearing their credential cookies.
`OAuth2Config.Builder`	`mergeTokenEndpoint(HttpUri value)` Endpoint on the authorization server to retrieve the access token from.
`OAuth2Config.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`OAuth2Config.Builder`	`removePassThroughMatcher(int index)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`setAuthorizationEndpoint(String value)` The endpoint redirect to for authorization in response to unauthorized requests.
`OAuth2Config.Builder`	`setAuthorizationEndpointBytes(com.google.protobuf.ByteString value)` The endpoint redirect to for authorization in response to unauthorized requests.
`OAuth2Config.Builder`	`setCredentials(OAuth2Credentials.Builder builderForValue)` Credentials used for OAuth.
`OAuth2Config.Builder`	`setCredentials(OAuth2Credentials value)` Credentials used for OAuth.
`OAuth2Config.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`OAuth2Config.Builder`	`setForwardBearerToken(boolean value)` Forward the OAuth token as a Bearer to upstream web service.
`OAuth2Config.Builder`	`setPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`setPassThroughMatcher(int index, HeaderMatcher value)` Any request that matches any of the provided matchers will be passed through without OAuth validation.
`OAuth2Config.Builder`	`setRedirectPathMatcher(PathMatcher.Builder builderForValue)` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`OAuth2Config.Builder`	`setRedirectPathMatcher(PathMatcher value)` Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
`OAuth2Config.Builder`	`setRedirectUri(String value)` The redirect URI passed to the authorization endpoint.
`OAuth2Config.Builder`	`setRedirectUriBytes(com.google.protobuf.ByteString value)` The redirect URI passed to the authorization endpoint.
`OAuth2Config.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`OAuth2Config.Builder`	`setSignoutPath(PathMatcher.Builder builderForValue)` The path to sign a user out, clearing their credential cookies.
`OAuth2Config.Builder`	`setSignoutPath(PathMatcher value)` The path to sign a user out, clearing their credential cookies.
`OAuth2Config.Builder`	`setTokenEndpoint(HttpUri.Builder builderForValue)` Endpoint on the authorization server to retrieve the access token from.
`OAuth2Config.Builder`	`setTokenEndpoint(HttpUri value)` Endpoint on the authorization server to retrieve the access token from.
`OAuth2Config.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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.Builder<OAuth2Config.Builder>

clear
```
public OAuth2Config.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

getDefaultInstanceForType
```
public OAuth2Config getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public OAuth2Config build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public OAuth2Config buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public OAuth2Config.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

setField

public OAuth2Config.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

clearField
```
public OAuth2Config.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

clearOneof
```
public OAuth2Config.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

setRepeatedField

public OAuth2Config.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

addRepeatedField

public OAuth2Config.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

mergeFrom
```
public OAuth2Config.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuth2Config.Builder>

mergeFrom

public OAuth2Config.Builder mergeFrom(OAuth2Config other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>

mergeFrom
```
public OAuth2Config.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuth2Config.Builder>

Throws:

IOException

hasTokenEndpoint
```
public boolean hasTokenEndpoint()
```
```
 Endpoint on the authorization server to retrieve the access token from.
 
```
.envoy.config.core.v3.HttpUri token_endpoint = 1;
Specified by:

hasTokenEndpoint in interface OAuth2ConfigOrBuilder

getTokenEndpoint
```
public HttpUri getTokenEndpoint()
```
```
 Endpoint on the authorization server to retrieve the access token from.
 
```
.envoy.config.core.v3.HttpUri token_endpoint = 1;
Specified by:

getTokenEndpoint in interface OAuth2ConfigOrBuilder

setTokenEndpoint

public OAuth2Config.Builder setTokenEndpoint(HttpUri value)

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

setTokenEndpoint

public OAuth2Config.Builder setTokenEndpoint(HttpUri.Builder builderForValue)

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

mergeTokenEndpoint

public OAuth2Config.Builder mergeTokenEndpoint(HttpUri value)

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

clearTokenEndpoint

public OAuth2Config.Builder clearTokenEndpoint()

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

getTokenEndpointBuilder

public HttpUri.Builder getTokenEndpointBuilder()

 Endpoint on the authorization server to retrieve the access token from.

.envoy.config.core.v3.HttpUri token_endpoint = 1;

getTokenEndpointOrBuilder
```
public HttpUriOrBuilder getTokenEndpointOrBuilder()
```
```
 Endpoint on the authorization server to retrieve the access token from.
 
```
.envoy.config.core.v3.HttpUri token_endpoint = 1;
Specified by:

getTokenEndpointOrBuilder in interface OAuth2ConfigOrBuilder

getAuthorizationEndpoint
```
public String getAuthorizationEndpoint()
```
```
 The endpoint redirect to for authorization in response to unauthorized requests.
 
```
string authorization_endpoint = 2 [(.validate.rules) = { ... }
Specified by:

getAuthorizationEndpoint in interface OAuth2ConfigOrBuilder

getAuthorizationEndpointBytes
```
public com.google.protobuf.ByteString getAuthorizationEndpointBytes()
```
```
 The endpoint redirect to for authorization in response to unauthorized requests.
 
```
string authorization_endpoint = 2 [(.validate.rules) = { ... }
Specified by:

getAuthorizationEndpointBytes in interface OAuth2ConfigOrBuilder

setAuthorizationEndpoint

public OAuth2Config.Builder setAuthorizationEndpoint(String value)

 The endpoint redirect to for authorization in response to unauthorized requests.

string authorization_endpoint = 2 [(.validate.rules) = { ... }

clearAuthorizationEndpoint

public OAuth2Config.Builder clearAuthorizationEndpoint()

 The endpoint redirect to for authorization in response to unauthorized requests.

string authorization_endpoint = 2 [(.validate.rules) = { ... }

setAuthorizationEndpointBytes

public OAuth2Config.Builder setAuthorizationEndpointBytes(com.google.protobuf.ByteString value)

 The endpoint redirect to for authorization in response to unauthorized requests.

string authorization_endpoint = 2 [(.validate.rules) = { ... }

hasCredentials
```
public boolean hasCredentials()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
Specified by:

hasCredentials in interface OAuth2ConfigOrBuilder

getCredentials
```
public OAuth2Credentials getCredentials()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
Specified by:

getCredentials in interface OAuth2ConfigOrBuilder

setCredentials
```
public OAuth2Config.Builder setCredentials(OAuth2Credentials value)
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

setCredentials

public OAuth2Config.Builder setCredentials(OAuth2Credentials.Builder builderForValue)

 Credentials used for OAuth.

.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

mergeCredentials
```
public OAuth2Config.Builder mergeCredentials(OAuth2Credentials value)
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

clearCredentials
```
public OAuth2Config.Builder clearCredentials()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

getCredentialsBuilder
```
public OAuth2Credentials.Builder getCredentialsBuilder()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }

getCredentialsOrBuilder
```
public OAuth2CredentialsOrBuilder getCredentialsOrBuilder()
```
```
 Credentials used for OAuth.
 
```
.envoy.extensions.filters.http.oauth2.v3alpha.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
Specified by:

getCredentialsOrBuilder in interface OAuth2ConfigOrBuilder

getRedirectUri

public String getRedirectUri()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

Specified by:: getRedirectUri in interface OAuth2ConfigOrBuilder

getRedirectUriBytes

public com.google.protobuf.ByteString getRedirectUriBytes()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

Specified by:: getRedirectUriBytes in interface OAuth2ConfigOrBuilder

setRedirectUri

public OAuth2Config.Builder setRedirectUri(String value)

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

clearRedirectUri

public OAuth2Config.Builder clearRedirectUri()

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

setRedirectUriBytes

public OAuth2Config.Builder setRedirectUriBytes(com.google.protobuf.ByteString value)

 The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.

string redirect_uri = 4 [(.validate.rules) = { ... }

hasRedirectPathMatcher
```
public boolean hasRedirectPathMatcher()
```
```
 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
 
```
.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }
Specified by:

hasRedirectPathMatcher in interface OAuth2ConfigOrBuilder

getRedirectPathMatcher
```
public PathMatcher getRedirectPathMatcher()
```
```
 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
 
```
.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }
Specified by:

getRedirectPathMatcher in interface OAuth2ConfigOrBuilder

setRedirectPathMatcher

public OAuth2Config.Builder setRedirectPathMatcher(PathMatcher value)

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

setRedirectPathMatcher

public OAuth2Config.Builder setRedirectPathMatcher(PathMatcher.Builder builderForValue)

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

mergeRedirectPathMatcher

public OAuth2Config.Builder mergeRedirectPathMatcher(PathMatcher value)

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

clearRedirectPathMatcher

public OAuth2Config.Builder clearRedirectPathMatcher()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

getRedirectPathMatcherBuilder

public PathMatcher.Builder getRedirectPathMatcherBuilder()

 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.

.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }

getRedirectPathMatcherOrBuilder
```
public PathMatcherOrBuilder getRedirectPathMatcherOrBuilder()
```
```
 Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
 
```
.envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }
Specified by:

getRedirectPathMatcherOrBuilder in interface OAuth2ConfigOrBuilder

hasSignoutPath
```
public boolean hasSignoutPath()
```
```
 The path to sign a user out, clearing their credential cookies.
 
```
.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }
Specified by:

hasSignoutPath in interface OAuth2ConfigOrBuilder

getSignoutPath
```
public PathMatcher getSignoutPath()
```
```
 The path to sign a user out, clearing their credential cookies.
 
```
.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }
Specified by:

getSignoutPath in interface OAuth2ConfigOrBuilder

setSignoutPath

public OAuth2Config.Builder setSignoutPath(PathMatcher value)

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

setSignoutPath

public OAuth2Config.Builder setSignoutPath(PathMatcher.Builder builderForValue)

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

mergeSignoutPath

public OAuth2Config.Builder mergeSignoutPath(PathMatcher value)

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

clearSignoutPath

public OAuth2Config.Builder clearSignoutPath()

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

getSignoutPathBuilder

public PathMatcher.Builder getSignoutPathBuilder()

 The path to sign a user out, clearing their credential cookies.

.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }

getSignoutPathOrBuilder
```
public PathMatcherOrBuilder getSignoutPathOrBuilder()
```
```
 The path to sign a user out, clearing their credential cookies.
 
```
.envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }
Specified by:

getSignoutPathOrBuilder in interface OAuth2ConfigOrBuilder

getForwardBearerToken
```
public boolean getForwardBearerToken()
```
```
 Forward the OAuth token as a Bearer to upstream web service.
 
```
bool forward_bearer_token = 7;
Specified by:

getForwardBearerToken in interface OAuth2ConfigOrBuilder

setForwardBearerToken

public OAuth2Config.Builder setForwardBearerToken(boolean value)

 Forward the OAuth token as a Bearer to upstream web service.

bool forward_bearer_token = 7;

clearForwardBearerToken

public OAuth2Config.Builder clearForwardBearerToken()

 Forward the OAuth token as a Bearer to upstream web service.

bool forward_bearer_token = 7;

getPassThroughMatcherList
```
public List<HeaderMatcher> getPassThroughMatcherList()
```
```
 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 
```
repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;
Specified by:

getPassThroughMatcherList in interface OAuth2ConfigOrBuilder

getPassThroughMatcherCount
```
public int getPassThroughMatcherCount()
```
```
 Any request that matches any of the provided matchers will be passed through without OAuth validation.
 
```
repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;
Specified by:

getPassThroughMatcherCount in interface OAuth2ConfigOrBuilder