- 2.65.0 (latest)
- 2.64.1
- 2.63.2
- 2.62.0
- 2.61.3
- 2.60.0
- 2.59.2
- 2.58.0
- 2.57.0
- 2.56.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.1
- 2.49.0
- 2.48.0
- 2.46.0
- 2.45.1
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.1
- 2.38.0
- 2.37.1
- 2.36.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.1
- 2.24.0
- 2.23.1
- 2.22.1
- 2.21.1
- 2.15.0
- 2.14.3
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.6
- 2.8.4
- 2.7.4
public static final class AuthRequirement.Builder extends GeneratedMessage.Builder<AuthRequirement.Builder> implements AuthRequirementOrBuilderUser-defined authentication requirements, including support for JSON Web Token (JWT).
Protobuf type google.api.AuthRequirement
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AuthRequirement.BuilderImplements
AuthRequirementOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public AuthRequirement build()| Returns | |
|---|---|
| Type | Description |
AuthRequirement |
|
buildPartial()
public AuthRequirement buildPartial()| Returns | |
|---|---|
| Type | Description |
AuthRequirement |
|
clear()
public AuthRequirement.Builder clear()| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
clearAudiences()
public AuthRequirement.Builder clearAudiences()NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
The list of JWT audiences. 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/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 = 2;
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
This builder for chaining. |
clearProviderId()
public AuthRequirement.Builder clearProviderId()id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
This builder for chaining. |
getAudiences()
public String getAudiences()NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
The list of JWT audiences. 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/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 = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The audiences. |
getAudiencesBytes()
public ByteString getAudiencesBytes()NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
The list of JWT audiences. 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/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 = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for audiences. |
getDefaultInstanceForType()
public AuthRequirement getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AuthRequirement |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getProviderId()
public String getProviderId()id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The providerId. |
getProviderIdBytes()
public ByteString getProviderIdBytes()id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for providerId. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(AuthRequirement other)
public AuthRequirement.Builder mergeFrom(AuthRequirement other)| Parameter | |
|---|---|
| Name | Description |
other |
AuthRequirement |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AuthRequirement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AuthRequirement.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
setAudiences(String value)
public AuthRequirement.Builder setAudiences(String value)NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
The list of JWT audiences. 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/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 = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe audiences to set. |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
This builder for chaining. |
setAudiencesBytes(ByteString value)
public AuthRequirement.Builder setAudiencesBytes(ByteString value)NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
The list of JWT audiences. 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/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 = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for audiences to set. |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
This builder for chaining. |
setProviderId(String value)
public AuthRequirement.Builder setProviderId(String value)id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe providerId to set. |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
This builder for chaining. |
setProviderIdBytes(ByteString value)
public AuthRequirement.Builder setProviderIdBytes(ByteString value)id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for providerId to set. |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
This builder for chaining. |