Package com.google.api
Class AuthProvider.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
-
- com.google.api.AuthProvider.Builder
-
- All Implemented Interfaces:
AuthProviderOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- AuthProvider
public static final class AuthProvider.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder> implements AuthProviderOrBuilder
Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Protobuf typegoogle.api.AuthProvider
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthProvider.BuilderaddAllJwtLocations(Iterable<? extends JwtLocation> values)Defines the locations to extract the JWT.AuthProvider.BuilderaddJwtLocations(int index, JwtLocation value)Defines the locations to extract the JWT.AuthProvider.BuilderaddJwtLocations(int index, JwtLocation.Builder builderForValue)Defines the locations to extract the JWT.AuthProvider.BuilderaddJwtLocations(JwtLocation value)Defines the locations to extract the JWT.AuthProvider.BuilderaddJwtLocations(JwtLocation.Builder builderForValue)Defines the locations to extract the JWT.JwtLocation.BuilderaddJwtLocationsBuilder()Defines the locations to extract the JWT.JwtLocation.BuilderaddJwtLocationsBuilder(int index)Defines the locations to extract the JWT.AuthProvider.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)AuthProviderbuild()AuthProviderbuildPartial()AuthProvider.Builderclear()AuthProvider.BuilderclearAudiences()The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).AuthProvider.BuilderclearAuthorizationUrl()Redirect URL if JWT token is required but not present or is expired.AuthProvider.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)AuthProvider.BuilderclearId()The unique identifier of the auth provider.AuthProvider.BuilderclearIssuer()Identifies the principal that issued the JWT.AuthProvider.BuilderclearJwksUri()URL of the provider's public key set to validate signature of the JWT.AuthProvider.BuilderclearJwtLocations()Defines the locations to extract the JWT.AuthProvider.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)AuthProvider.Builderclone()StringgetAudiences()The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).com.google.protobuf.ByteStringgetAudiencesBytes()The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).StringgetAuthorizationUrl()Redirect URL if JWT token is required but not present or is expired.com.google.protobuf.ByteStringgetAuthorizationUrlBytes()Redirect URL if JWT token is required but not present or is expired.AuthProvidergetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetId()The unique identifier of the auth provider.com.google.protobuf.ByteStringgetIdBytes()The unique identifier of the auth provider.StringgetIssuer()Identifies the principal that issued the JWT.com.google.protobuf.ByteStringgetIssuerBytes()Identifies the principal that issued the JWT.StringgetJwksUri()URL of the provider's public key set to validate signature of the JWT.com.google.protobuf.ByteStringgetJwksUriBytes()URL of the provider's public key set to validate signature of the JWT.JwtLocationgetJwtLocations(int index)Defines the locations to extract the JWT.JwtLocation.BuildergetJwtLocationsBuilder(int index)Defines the locations to extract the JWT.List<JwtLocation.Builder>getJwtLocationsBuilderList()Defines the locations to extract the JWT.intgetJwtLocationsCount()Defines the locations to extract the JWT.List<JwtLocation>getJwtLocationsList()Defines the locations to extract the JWT.JwtLocationOrBuildergetJwtLocationsOrBuilder(int index)Defines the locations to extract the JWT.List<? extends JwtLocationOrBuilder>getJwtLocationsOrBuilderList()Defines the locations to extract the JWT.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()AuthProvider.BuildermergeFrom(AuthProvider other)AuthProvider.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)AuthProvider.BuildermergeFrom(com.google.protobuf.Message other)AuthProvider.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)AuthProvider.BuilderremoveJwtLocations(int index)Defines the locations to extract the JWT.AuthProvider.BuildersetAudiences(String value)The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).AuthProvider.BuildersetAudiencesBytes(com.google.protobuf.ByteString value)The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).AuthProvider.BuildersetAuthorizationUrl(String value)Redirect URL if JWT token is required but not present or is expired.AuthProvider.BuildersetAuthorizationUrlBytes(com.google.protobuf.ByteString value)Redirect URL if JWT token is required but not present or is expired.AuthProvider.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)AuthProvider.BuildersetId(String value)The unique identifier of the auth provider.AuthProvider.BuildersetIdBytes(com.google.protobuf.ByteString value)The unique identifier of the auth provider.AuthProvider.BuildersetIssuer(String value)Identifies the principal that issued the JWT.AuthProvider.BuildersetIssuerBytes(com.google.protobuf.ByteString value)Identifies the principal that issued the JWT.AuthProvider.BuildersetJwksUri(String value)URL of the provider's public key set to validate signature of the JWT.AuthProvider.BuildersetJwksUriBytes(com.google.protobuf.ByteString value)URL of the provider's public key set to validate signature of the JWT.AuthProvider.BuildersetJwtLocations(int index, JwtLocation value)Defines the locations to extract the JWT.AuthProvider.BuildersetJwtLocations(int index, JwtLocation.Builder builderForValue)Defines the locations to extract the JWT.AuthProvider.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)AuthProvider.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, 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<AuthProvider.Builder>
-
clear
public AuthProvider.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<AuthProvider.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<AuthProvider.Builder>
-
getDefaultInstanceForType
public AuthProvider getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public AuthProvider build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public AuthProvider buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public AuthProvider.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<AuthProvider.Builder>
-
setField
public AuthProvider.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<AuthProvider.Builder>
-
clearField
public AuthProvider.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
-
clearOneof
public AuthProvider.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
-
setRepeatedField
public AuthProvider.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<AuthProvider.Builder>
-
addRepeatedField
public AuthProvider.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<AuthProvider.Builder>
-
mergeFrom
public AuthProvider.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AuthProvider.Builder>
-
mergeFrom
public AuthProvider.Builder mergeFrom(AuthProvider other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
-
mergeFrom
public AuthProvider.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<AuthProvider.Builder>- Throws:
IOException
-
getId
public String getId()
The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
string id = 1;- Specified by:
getIdin interfaceAuthProviderOrBuilder- Returns:
- The id.
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
string id = 1;- Specified by:
getIdBytesin interfaceAuthProviderOrBuilder- Returns:
- The bytes for id.
-
setId
public AuthProvider.Builder setId(String value)
The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
string id = 1;- Parameters:
value- The id to set.- Returns:
- This builder for chaining.
-
clearId
public AuthProvider.Builder clearId()
The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
string id = 1;- Returns:
- This builder for chaining.
-
setIdBytes
public AuthProvider.Builder setIdBytes(com.google.protobuf.ByteString value)
The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
string id = 1;- Parameters:
value- The bytes for id to set.- Returns:
- This builder for chaining.
-
getIssuer
public String getIssuer()
Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;- Specified by:
getIssuerin interfaceAuthProviderOrBuilder- Returns:
- The issuer.
-
getIssuerBytes
public com.google.protobuf.ByteString getIssuerBytes()
Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;- Specified by:
getIssuerBytesin interfaceAuthProviderOrBuilder- Returns:
- The bytes for issuer.
-
setIssuer
public AuthProvider.Builder setIssuer(String value)
Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;- Parameters:
value- The issuer to set.- Returns:
- This builder for chaining.
-
clearIssuer
public AuthProvider.Builder clearIssuer()
Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;- Returns:
- This builder for chaining.
-
setIssuerBytes
public AuthProvider.Builder setIssuerBytes(com.google.protobuf.ByteString value)
Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;- Parameters:
value- The bytes for issuer to set.- Returns:
- This builder for chaining.
-
getJwksUri
public String getJwksUri()
URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certsstring jwks_uri = 3;- Specified by:
getJwksUriin interfaceAuthProviderOrBuilder- Returns:
- The jwksUri.
-
getJwksUriBytes
public com.google.protobuf.ByteString getJwksUriBytes()
URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certsstring jwks_uri = 3;- Specified by:
getJwksUriBytesin interfaceAuthProviderOrBuilder- Returns:
- The bytes for jwksUri.
-
setJwksUri
public AuthProvider.Builder setJwksUri(String value)
URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certsstring jwks_uri = 3;- Parameters:
value- The jwksUri to set.- Returns:
- This builder for chaining.
-
clearJwksUri
public AuthProvider.Builder clearJwksUri()
URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certsstring jwks_uri = 3;- Returns:
- This builder for chaining.
-
setJwksUriBytes
public AuthProvider.Builder setJwksUriBytes(com.google.protobuf.ByteString value)
URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certsstring jwks_uri = 3;- Parameters:
value- The bytes for jwksUri to set.- Returns:
- This builder for chaining.
-
getAudiences
public String getAudiences()
The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.comstring audiences = 4;- Specified by:
getAudiencesin interfaceAuthProviderOrBuilder- Returns:
- The audiences.
-
getAudiencesBytes
public com.google.protobuf.ByteString getAudiencesBytes()
The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.comstring audiences = 4;- Specified by:
getAudiencesBytesin interfaceAuthProviderOrBuilder- Returns:
- The bytes for audiences.
-
setAudiences
public AuthProvider.Builder setAudiences(String value)
The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.comstring audiences = 4;- Parameters:
value- The audiences to set.- Returns:
- This builder for chaining.
-
clearAudiences
public AuthProvider.Builder clearAudiences()
The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.comstring audiences = 4;- Returns:
- This builder for chaining.
-
setAudiencesBytes
public AuthProvider.Builder setAudiencesBytes(com.google.protobuf.ByteString value)
The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.comstring audiences = 4;- Parameters:
value- The bytes for audiences to set.- Returns:
- This builder for chaining.
-
getAuthorizationUrl
public String getAuthorizationUrl()
Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
string authorization_url = 5;- Specified by:
getAuthorizationUrlin interfaceAuthProviderOrBuilder- Returns:
- The authorizationUrl.
-
getAuthorizationUrlBytes
public com.google.protobuf.ByteString getAuthorizationUrlBytes()
Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
string authorization_url = 5;- Specified by:
getAuthorizationUrlBytesin interfaceAuthProviderOrBuilder- Returns:
- The bytes for authorizationUrl.
-
setAuthorizationUrl
public AuthProvider.Builder setAuthorizationUrl(String value)
Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
string authorization_url = 5;- Parameters:
value- The authorizationUrl to set.- Returns:
- This builder for chaining.
-
clearAuthorizationUrl
public AuthProvider.Builder clearAuthorizationUrl()
Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
string authorization_url = 5;- Returns:
- This builder for chaining.
-
setAuthorizationUrlBytes
public AuthProvider.Builder setAuthorizationUrlBytes(com.google.protobuf.ByteString value)
Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
string authorization_url = 5;- Parameters:
value- The bytes for authorizationUrl to set.- Returns:
- This builder for chaining.
-
getJwtLocationsList
public List<JwtLocation> getJwtLocationsList()
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;- Specified by:
getJwtLocationsListin interfaceAuthProviderOrBuilder
-
getJwtLocationsCount
public int getJwtLocationsCount()
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;- Specified by:
getJwtLocationsCountin interfaceAuthProviderOrBuilder
-
getJwtLocations
public JwtLocation getJwtLocations(int index)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;- Specified by:
getJwtLocationsin interfaceAuthProviderOrBuilder
-
setJwtLocations
public AuthProvider.Builder setJwtLocations(int index, JwtLocation value)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
setJwtLocations
public AuthProvider.Builder setJwtLocations(int index, JwtLocation.Builder builderForValue)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
addJwtLocations
public AuthProvider.Builder addJwtLocations(JwtLocation value)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
addJwtLocations
public AuthProvider.Builder addJwtLocations(int index, JwtLocation value)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
addJwtLocations
public AuthProvider.Builder addJwtLocations(JwtLocation.Builder builderForValue)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
addJwtLocations
public AuthProvider.Builder addJwtLocations(int index, JwtLocation.Builder builderForValue)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
addAllJwtLocations
public AuthProvider.Builder addAllJwtLocations(Iterable<? extends JwtLocation> values)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
clearJwtLocations
public AuthProvider.Builder clearJwtLocations()
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
removeJwtLocations
public AuthProvider.Builder removeJwtLocations(int index)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
getJwtLocationsBuilder
public JwtLocation.Builder getJwtLocationsBuilder(int index)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
getJwtLocationsOrBuilder
public JwtLocationOrBuilder getJwtLocationsOrBuilder(int index)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;- Specified by:
getJwtLocationsOrBuilderin interfaceAuthProviderOrBuilder
-
getJwtLocationsOrBuilderList
public List<? extends JwtLocationOrBuilder> getJwtLocationsOrBuilderList()
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;- Specified by:
getJwtLocationsOrBuilderListin interfaceAuthProviderOrBuilder
-
addJwtLocationsBuilder
public JwtLocation.Builder addJwtLocationsBuilder()
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
addJwtLocationsBuilder
public JwtLocation.Builder addJwtLocationsBuilder(int index)
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
getJwtLocationsBuilderList
public List<JwtLocation.Builder> getJwtLocationsBuilderList()
Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_tokenrepeated .google.api.JwtLocation jwt_locations = 6;
-
setUnknownFields
public final AuthProvider.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
-
mergeUnknownFields
public final AuthProvider.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
-
-