AuthProvider.Builder (common-protos-java 1.14.0 API)

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, java.lang.Cloneable

Enclosing class:: AuthProvider

public static final class AuthProvider.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>
implements AuthProviderOrBuilder

 Configuration for an anthentication provider, including support for
 [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

Protobuf type google.api.AuthProvider

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthProvider.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`AuthProvider`	`build()`
`AuthProvider`	`buildPartial()`
`AuthProvider.Builder`	`clear()`
`AuthProvider.Builder`	`clearAudiences()` The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
`AuthProvider.Builder`	`clearAuthorizationUrl()` Redirect URL if JWT token is required but not present or is expired.
`AuthProvider.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`AuthProvider.Builder`	`clearId()` The unique identifier of the auth provider.
`AuthProvider.Builder`	`clearIssuer()` Identifies the principal that issued the JWT.
`AuthProvider.Builder`	`clearJwksUri()` URL of the provider's public key set to validate signature of the JWT.
`AuthProvider.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`AuthProvider.Builder`	`clone()`
`java.lang.String`	`getAudiences()` The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
`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).
`java.lang.String`	`getAuthorizationUrl()` Redirect URL if JWT token is required but not present or is expired.
`com.google.protobuf.ByteString`	`getAuthorizationUrlBytes()` Redirect URL if JWT token is required but not present or is expired.
`AuthProvider`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getId()` The unique identifier of the auth provider.
`com.google.protobuf.ByteString`	`getIdBytes()` The unique identifier of the auth provider.
`java.lang.String`	`getIssuer()` Identifies the principal that issued the JWT.
`com.google.protobuf.ByteString`	`getIssuerBytes()` Identifies the principal that issued the JWT.
`java.lang.String`	`getJwksUri()` URL of the provider's public key set to validate signature of the JWT.
`com.google.protobuf.ByteString`	`getJwksUriBytes()` URL of the provider's public key set to validate signature of the JWT.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`AuthProvider.Builder`	`mergeFrom(AuthProvider other)`
`AuthProvider.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`AuthProvider.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`AuthProvider.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`AuthProvider.Builder`	`setAudiences(java.lang.String value)` The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
`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).
`AuthProvider.Builder`	`setAuthorizationUrl(java.lang.String value)` Redirect URL if JWT token is required but not present or is expired.
`AuthProvider.Builder`	`setAuthorizationUrlBytes(com.google.protobuf.ByteString value)` Redirect URL if JWT token is required but not present or is expired.
`AuthProvider.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`AuthProvider.Builder`	`setId(java.lang.String value)` The unique identifier of the auth provider.
`AuthProvider.Builder`	`setIdBytes(com.google.protobuf.ByteString value)` The unique identifier of the auth provider.
`AuthProvider.Builder`	`setIssuer(java.lang.String value)` Identifies the principal that issued the JWT.
`AuthProvider.Builder`	`setIssuerBytes(com.google.protobuf.ByteString value)` Identifies the principal that issued the JWT.
`AuthProvider.Builder`	`setJwksUri(java.lang.String value)` URL of the provider's public key set to validate signature of the JWT.
`AuthProvider.Builder`	`setJwksUriBytes(com.google.protobuf.ByteString value)` URL of the provider's public key set to validate signature of the JWT.
`AuthProvider.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`AuthProvider.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<AuthProvider.Builder>

clear
```
public AuthProvider.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<AuthProvider.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<AuthProvider.Builder>

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

clone
```
public AuthProvider.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<AuthProvider.Builder>

setField
```
public AuthProvider.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     java.lang.Object value)
```
Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>

clearField
```
public AuthProvider.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<AuthProvider.Builder>

clearOneof
```
public AuthProvider.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<AuthProvider.Builder>

setRepeatedField

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

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

addRepeatedField
```
public AuthProvider.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             java.lang.Object value)
```
Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AuthProvider.Builder>

mergeFrom
```
public AuthProvider.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<AuthProvider.Builder>

mergeFrom

public AuthProvider.Builder mergeFrom(AuthProvider other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public AuthProvider.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.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<AuthProvider.Builder>

Throws:

java.io.IOException

getId

public java.lang.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:: getId in interface AuthProviderOrBuilder

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:: getIdBytes in interface AuthProviderOrBuilder

setId

public AuthProvider.Builder setId(java.lang.String value)

 The unique identifier of the auth provider. It will be referred to by
 `AuthRequirement.provider_id`.
 Example: "bookstore_auth".

string id = 1;

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;

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;

getIssuer

public java.lang.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:: getIssuer in interface AuthProviderOrBuilder

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:: getIssuerBytes in interface AuthProviderOrBuilder

setIssuer

public AuthProvider.Builder setIssuer(java.lang.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;

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;

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;

getJwksUri

public java.lang.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/certs

string jwks_uri = 3;

Specified by:: getJwksUri in interface AuthProviderOrBuilder

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/certs

string jwks_uri = 3;

Specified by:: getJwksUriBytes in interface AuthProviderOrBuilder

setJwksUri

public AuthProvider.Builder setJwksUri(java.lang.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/certs

string jwks_uri = 3;

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/certs

string jwks_uri = 3;

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/certs

string jwks_uri = 3;

getAudiences

public java.lang.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, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com

string audiences = 4;

Specified by:: getAudiences in interface AuthProviderOrBuilder

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, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com

string audiences = 4;

Specified by:: getAudiencesBytes in interface AuthProviderOrBuilder

setAudiences

public AuthProvider.Builder setAudiences(java.lang.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, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com

string audiences = 4;

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, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com

string audiences = 4;

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, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com

string audiences = 4;