Class OAuth2Config.Builder
- 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.v3.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: 11]
Protobuf typeenvoy.extensions.filters.http.oauth2.v3.OAuth2Config
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OAuth2Config.BuilderaddAllAuthScopes(Iterable<String> values)Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.BuilderaddAllPassThroughMatcher(Iterable<? extends HeaderMatcher> values)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuilderaddAllResources(Iterable<String> values)Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.BuilderaddAuthScopes(String value)Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.BuilderaddAuthScopesBytes(com.google.protobuf.ByteString value)Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.BuilderaddPassThroughMatcher(int index, HeaderMatcher value)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuilderaddPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuilderaddPassThroughMatcher(HeaderMatcher value)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuilderaddPassThroughMatcher(HeaderMatcher.Builder builderForValue)Any request that matches any of the provided matchers will be passed through without OAuth validation.HeaderMatcher.BuilderaddPassThroughMatcherBuilder()Any request that matches any of the provided matchers will be passed through without OAuth validation.HeaderMatcher.BuilderaddPassThroughMatcherBuilder(int index)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)OAuth2Config.BuilderaddResources(String value)Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.BuilderaddResourcesBytes(com.google.protobuf.ByteString value)Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Configbuild()OAuth2ConfigbuildPartial()OAuth2Config.Builderclear()OAuth2Config.BuilderclearAuthorizationEndpoint()The endpoint redirect to for authorization in response to unauthorized requests.OAuth2Config.BuilderclearAuthScopes()Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.BuilderclearCredentials()Credentials used for OAuth.OAuth2Config.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)OAuth2Config.BuilderclearForwardBearerToken()Forward the OAuth token as a Bearer to upstream web service.OAuth2Config.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)OAuth2Config.BuilderclearPassThroughMatcher()Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuilderclearRedirectPathMatcher()Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.BuilderclearRedirectUri()The redirect URI passed to the authorization endpoint.OAuth2Config.BuilderclearResources()Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.BuilderclearSignoutPath()The path to sign a user out, clearing their credential cookies.OAuth2Config.BuilderclearTokenEndpoint()Endpoint on the authorization server to retrieve the access token from.OAuth2Config.Builderclone()StringgetAuthorizationEndpoint()The endpoint redirect to for authorization in response to unauthorized requests.com.google.protobuf.ByteStringgetAuthorizationEndpointBytes()The endpoint redirect to for authorization in response to unauthorized requests.StringgetAuthScopes(int index)Optional list of OAuth scopes to be claimed in the authorization request.com.google.protobuf.ByteStringgetAuthScopesBytes(int index)Optional list of OAuth scopes to be claimed in the authorization request.intgetAuthScopesCount()Optional list of OAuth scopes to be claimed in the authorization request.com.google.protobuf.ProtocolStringListgetAuthScopesList()Optional list of OAuth scopes to be claimed in the authorization request.OAuth2CredentialsgetCredentials()Credentials used for OAuth.OAuth2Credentials.BuildergetCredentialsBuilder()Credentials used for OAuth.OAuth2CredentialsOrBuildergetCredentialsOrBuilder()Credentials used for OAuth.OAuth2ConfiggetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()booleangetForwardBearerToken()Forward the OAuth token as a Bearer to upstream web service.HeaderMatchergetPassThroughMatcher(int index)Any request that matches any of the provided matchers will be passed through without OAuth validation.HeaderMatcher.BuildergetPassThroughMatcherBuilder(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.intgetPassThroughMatcherCount()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.HeaderMatcherOrBuildergetPassThroughMatcherOrBuilder(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.PathMatchergetRedirectPathMatcher()Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.PathMatcher.BuildergetRedirectPathMatcherBuilder()Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.PathMatcherOrBuildergetRedirectPathMatcherOrBuilder()Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.StringgetRedirectUri()The redirect URI passed to the authorization endpoint.com.google.protobuf.ByteStringgetRedirectUriBytes()The redirect URI passed to the authorization endpoint.StringgetResources(int index)Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707com.google.protobuf.ByteStringgetResourcesBytes(int index)Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707intgetResourcesCount()Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707com.google.protobuf.ProtocolStringListgetResourcesList()Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707PathMatchergetSignoutPath()The path to sign a user out, clearing their credential cookies.PathMatcher.BuildergetSignoutPathBuilder()The path to sign a user out, clearing their credential cookies.PathMatcherOrBuildergetSignoutPathOrBuilder()The path to sign a user out, clearing their credential cookies.HttpUrigetTokenEndpoint()Endpoint on the authorization server to retrieve the access token from.HttpUri.BuildergetTokenEndpointBuilder()Endpoint on the authorization server to retrieve the access token from.HttpUriOrBuildergetTokenEndpointOrBuilder()Endpoint on the authorization server to retrieve the access token from.booleanhasCredentials()Credentials used for OAuth.booleanhasRedirectPathMatcher()Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.booleanhasSignoutPath()The path to sign a user out, clearing their credential cookies.booleanhasTokenEndpoint()Endpoint on the authorization server to retrieve the access token from.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()OAuth2Config.BuildermergeCredentials(OAuth2Credentials value)Credentials used for OAuth.OAuth2Config.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)OAuth2Config.BuildermergeFrom(com.google.protobuf.Message other)OAuth2Config.BuildermergeFrom(OAuth2Config other)OAuth2Config.BuildermergeRedirectPathMatcher(PathMatcher value)Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.BuildermergeSignoutPath(PathMatcher value)The path to sign a user out, clearing their credential cookies.OAuth2Config.BuildermergeTokenEndpoint(HttpUri value)Endpoint on the authorization server to retrieve the access token from.OAuth2Config.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)OAuth2Config.BuilderremovePassThroughMatcher(int index)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuildersetAuthorizationEndpoint(String value)The endpoint redirect to for authorization in response to unauthorized requests.OAuth2Config.BuildersetAuthorizationEndpointBytes(com.google.protobuf.ByteString value)The endpoint redirect to for authorization in response to unauthorized requests.OAuth2Config.BuildersetAuthScopes(int index, String value)Optional list of OAuth scopes to be claimed in the authorization request.OAuth2Config.BuildersetCredentials(OAuth2Credentials value)Credentials used for OAuth.OAuth2Config.BuildersetCredentials(OAuth2Credentials.Builder builderForValue)Credentials used for OAuth.OAuth2Config.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)OAuth2Config.BuildersetForwardBearerToken(boolean value)Forward the OAuth token as a Bearer to upstream web service.OAuth2Config.BuildersetPassThroughMatcher(int index, HeaderMatcher value)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuildersetPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue)Any request that matches any of the provided matchers will be passed through without OAuth validation.OAuth2Config.BuildersetRedirectPathMatcher(PathMatcher value)Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.BuildersetRedirectPathMatcher(PathMatcher.Builder builderForValue)Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.OAuth2Config.BuildersetRedirectUri(String value)The redirect URI passed to the authorization endpoint.OAuth2Config.BuildersetRedirectUriBytes(com.google.protobuf.ByteString value)The redirect URI passed to the authorization endpoint.OAuth2Config.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)OAuth2Config.BuildersetResources(int index, String value)Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707OAuth2Config.BuildersetSignoutPath(PathMatcher value)The path to sign a user out, clearing their credential cookies.OAuth2Config.BuildersetSignoutPath(PathMatcher.Builder builderForValue)The path to sign a user out, clearing their credential cookies.OAuth2Config.BuildersetTokenEndpoint(HttpUri value)Endpoint on the authorization server to retrieve the access token from.OAuth2Config.BuildersetTokenEndpoint(HttpUri.Builder builderForValue)Endpoint on the authorization server to retrieve the access token from.OAuth2Config.BuildersetUnknownFields(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, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
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.Builder<OAuth2Config.Builder>
-
clear
public OAuth2Config.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
getDefaultInstanceForType
public OAuth2Config getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public OAuth2Config build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public OAuth2Config buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public OAuth2Config.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
setField
public OAuth2Config.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
clearField
public OAuth2Config.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
clearOneof
public OAuth2Config.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
setRepeatedField
public OAuth2Config.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
addRepeatedField
public OAuth2Config.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
mergeFrom
public OAuth2Config.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<OAuth2Config.Builder>
-
mergeFrom
public OAuth2Config.Builder mergeFrom(OAuth2Config other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.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:
hasTokenEndpointin interfaceOAuth2ConfigOrBuilder- Returns:
- Whether the tokenEndpoint field is set.
-
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:
getTokenEndpointin interfaceOAuth2ConfigOrBuilder- Returns:
- The tokenEndpoint.
-
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:
getTokenEndpointOrBuilderin interfaceOAuth2ConfigOrBuilder
-
getAuthorizationEndpoint
public String getAuthorizationEndpoint()
The endpoint redirect to for authorization in response to unauthorized requests.
string authorization_endpoint = 2 [(.validate.rules) = { ... }- Specified by:
getAuthorizationEndpointin interfaceOAuth2ConfigOrBuilder- Returns:
- The authorizationEndpoint.
-
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:
getAuthorizationEndpointBytesin interfaceOAuth2ConfigOrBuilder- Returns:
- The bytes for authorizationEndpoint.
-
setAuthorizationEndpoint
public OAuth2Config.Builder setAuthorizationEndpoint(String value)
The endpoint redirect to for authorization in response to unauthorized requests.
string authorization_endpoint = 2 [(.validate.rules) = { ... }- Parameters:
value- The authorizationEndpoint to set.- Returns:
- This builder for chaining.
-
clearAuthorizationEndpoint
public OAuth2Config.Builder clearAuthorizationEndpoint()
The endpoint redirect to for authorization in response to unauthorized requests.
string authorization_endpoint = 2 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
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) = { ... }- Parameters:
value- The bytes for authorizationEndpoint to set.- Returns:
- This builder for chaining.
-
hasCredentials
public boolean hasCredentials()
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }- Specified by:
hasCredentialsin interfaceOAuth2ConfigOrBuilder- Returns:
- Whether the credentials field is set.
-
getCredentials
public OAuth2Credentials getCredentials()
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }- Specified by:
getCredentialsin interfaceOAuth2ConfigOrBuilder- Returns:
- The credentials.
-
setCredentials
public OAuth2Config.Builder setCredentials(OAuth2Credentials value)
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
-
setCredentials
public OAuth2Config.Builder setCredentials(OAuth2Credentials.Builder builderForValue)
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
-
mergeCredentials
public OAuth2Config.Builder mergeCredentials(OAuth2Credentials value)
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
-
clearCredentials
public OAuth2Config.Builder clearCredentials()
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
-
getCredentialsBuilder
public OAuth2Credentials.Builder getCredentialsBuilder()
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
-
getCredentialsOrBuilder
public OAuth2CredentialsOrBuilder getCredentialsOrBuilder()
Credentials used for OAuth.
.envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }- Specified by:
getCredentialsOrBuilderin interfaceOAuth2ConfigOrBuilder
-
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:
getRedirectUriin interfaceOAuth2ConfigOrBuilder- Returns:
- The redirectUri.
-
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:
getRedirectUriBytesin interfaceOAuth2ConfigOrBuilder- Returns:
- The bytes for redirectUri.
-
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) = { ... }- Parameters:
value- The redirectUri to set.- Returns:
- This builder for chaining.
-
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) = { ... }- Returns:
- This builder for chaining.
-
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) = { ... }- Parameters:
value- The bytes for redirectUri to set.- Returns:
- This builder for chaining.
-
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:
hasRedirectPathMatcherin interfaceOAuth2ConfigOrBuilder- Returns:
- Whether the redirectPathMatcher field is set.
-
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:
getRedirectPathMatcherin interfaceOAuth2ConfigOrBuilder- Returns:
- The redirectPathMatcher.
-
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:
getRedirectPathMatcherOrBuilderin interfaceOAuth2ConfigOrBuilder
-
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:
hasSignoutPathin interfaceOAuth2ConfigOrBuilder- Returns:
- Whether the signoutPath field is set.
-
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:
getSignoutPathin interfaceOAuth2ConfigOrBuilder- Returns:
- The signoutPath.
-
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:
getSignoutPathOrBuilderin interfaceOAuth2ConfigOrBuilder
-
getForwardBearerToken
public boolean getForwardBearerToken()
Forward the OAuth token as a Bearer to upstream web service.
bool forward_bearer_token = 7;- Specified by:
getForwardBearerTokenin interfaceOAuth2ConfigOrBuilder- Returns:
- The forwardBearerToken.
-
setForwardBearerToken
public OAuth2Config.Builder setForwardBearerToken(boolean value)
Forward the OAuth token as a Bearer to upstream web service.
bool forward_bearer_token = 7;- Parameters:
value- The forwardBearerToken to set.- Returns:
- This builder for chaining.
-
clearForwardBearerToken
public OAuth2Config.Builder clearForwardBearerToken()
Forward the OAuth token as a Bearer to upstream web service.
bool forward_bearer_token = 7;- Returns:
- This builder for chaining.
-
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:
getPassThroughMatcherListin interfaceOAuth2ConfigOrBuilder
-
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:
getPassThroughMatcherCountin interfaceOAuth2ConfigOrBuilder
-
getPassThroughMatcher
public HeaderMatcher getPassThroughMatcher(int index)
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:
getPassThroughMatcherin interfaceOAuth2ConfigOrBuilder
-
setPassThroughMatcher
public OAuth2Config.Builder setPassThroughMatcher(int index, HeaderMatcher value)
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;
-
setPassThroughMatcher
public OAuth2Config.Builder setPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue)
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;
-
addPassThroughMatcher
public OAuth2Config.Builder addPassThroughMatcher(HeaderMatcher value)
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;
-
addPassThroughMatcher
public OAuth2Config.Builder addPassThroughMatcher(int index, HeaderMatcher value)
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;
-
addPassThroughMatcher
public OAuth2Config.Builder addPassThroughMatcher(HeaderMatcher.Builder builderForValue)
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;
-
addPassThroughMatcher
public OAuth2Config.Builder addPassThroughMatcher(int index, HeaderMatcher.Builder builderForValue)
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;
-
addAllPassThroughMatcher
public OAuth2Config.Builder addAllPassThroughMatcher(Iterable<? extends HeaderMatcher> values)
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;
-
clearPassThroughMatcher
public OAuth2Config.Builder clearPassThroughMatcher()
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;
-
removePassThroughMatcher
public OAuth2Config.Builder removePassThroughMatcher(int index)
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;
-
getPassThroughMatcherBuilder
public HeaderMatcher.Builder getPassThroughMatcherBuilder(int index)
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;
-
getPassThroughMatcherOrBuilder
public HeaderMatcherOrBuilder getPassThroughMatcherOrBuilder(int index)
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:
getPassThroughMatcherOrBuilderin interfaceOAuth2ConfigOrBuilder
-
getPassThroughMatcherOrBuilderList
public List<? extends HeaderMatcherOrBuilder> getPassThroughMatcherOrBuilderList()
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:
getPassThroughMatcherOrBuilderListin interfaceOAuth2ConfigOrBuilder
-
addPassThroughMatcherBuilder
public HeaderMatcher.Builder addPassThroughMatcherBuilder()
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;
-
addPassThroughMatcherBuilder
public HeaderMatcher.Builder addPassThroughMatcherBuilder(int index)
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;
-
getPassThroughMatcherBuilderList
public List<HeaderMatcher.Builder> getPassThroughMatcherBuilderList()
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;
-
getAuthScopesList
public com.google.protobuf.ProtocolStringList getAuthScopesList()
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Specified by:
getAuthScopesListin interfaceOAuth2ConfigOrBuilder- Returns:
- A list containing the authScopes.
-
getAuthScopesCount
public int getAuthScopesCount()
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Specified by:
getAuthScopesCountin interfaceOAuth2ConfigOrBuilder- Returns:
- The count of authScopes.
-
getAuthScopes
public String getAuthScopes(int index)
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Specified by:
getAuthScopesin interfaceOAuth2ConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The authScopes at the given index.
-
getAuthScopesBytes
public com.google.protobuf.ByteString getAuthScopesBytes(int index)
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Specified by:
getAuthScopesBytesin interfaceOAuth2ConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the authScopes at the given index.
-
setAuthScopes
public OAuth2Config.Builder setAuthScopes(int index, String value)
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Parameters:
index- The index to set the value at.value- The authScopes to set.- Returns:
- This builder for chaining.
-
addAuthScopes
public OAuth2Config.Builder addAuthScopes(String value)
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Parameters:
value- The authScopes to add.- Returns:
- This builder for chaining.
-
addAllAuthScopes
public OAuth2Config.Builder addAllAuthScopes(Iterable<String> values)
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Parameters:
values- The authScopes to add.- Returns:
- This builder for chaining.
-
clearAuthScopes
public OAuth2Config.Builder clearAuthScopes()
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Returns:
- This builder for chaining.
-
addAuthScopesBytes
public OAuth2Config.Builder addAuthScopesBytes(com.google.protobuf.ByteString value)
Optional list of OAuth scopes to be claimed in the authorization request. If not specified, defaults to "user" scope. OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
repeated string auth_scopes = 9;- Parameters:
value- The bytes of the authScopes to add.- Returns:
- This builder for chaining.
-
getResourcesList
public com.google.protobuf.ProtocolStringList getResourcesList()
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Specified by:
getResourcesListin interfaceOAuth2ConfigOrBuilder- Returns:
- A list containing the resources.
-
getResourcesCount
public int getResourcesCount()
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Specified by:
getResourcesCountin interfaceOAuth2ConfigOrBuilder- Returns:
- The count of resources.
-
getResources
public String getResources(int index)
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Specified by:
getResourcesin interfaceOAuth2ConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The resources at the given index.
-
getResourcesBytes
public com.google.protobuf.ByteString getResourcesBytes(int index)
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Specified by:
getResourcesBytesin interfaceOAuth2ConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the resources at the given index.
-
setResources
public OAuth2Config.Builder setResources(int index, String value)
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Parameters:
index- The index to set the value at.value- The resources to set.- Returns:
- This builder for chaining.
-
addResources
public OAuth2Config.Builder addResources(String value)
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Parameters:
value- The resources to add.- Returns:
- This builder for chaining.
-
addAllResources
public OAuth2Config.Builder addAllResources(Iterable<String> values)
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Parameters:
values- The resources to add.- Returns:
- This builder for chaining.
-
clearResources
public OAuth2Config.Builder clearResources()
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Returns:
- This builder for chaining.
-
addResourcesBytes
public OAuth2Config.Builder addResourcesBytes(com.google.protobuf.ByteString value)
Optional resource parameter for authorization request RFC: https://tools.ietf.org/html/rfc8707
repeated string resources = 10;- Parameters:
value- The bytes of the resources to add.- Returns:
- This builder for chaining.
-
setUnknownFields
public final OAuth2Config.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
mergeUnknownFields
public final OAuth2Config.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<OAuth2Config.Builder>
-
-