public static final class AuthRequirement.Builder extends GeneratedMessageV3.Builder<AuthRequirement.Builder> implements AuthRequirementOrBuilderUser-defined authentication requirements, including support for JSON Web Token (JWT).
Protobuf type google.api.AuthRequirement
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AuthRequirement.BuilderImplements
AuthRequirementOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AuthRequirement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
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. |
clearField(Descriptors.FieldDescriptor field)
public AuthRequirement.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public AuthRequirement.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
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. |
clone()
public AuthRequirement.Builder clone()| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
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 GeneratedMessageV3.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 |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AuthRequirement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| 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. |
setField(Descriptors.FieldDescriptor field, Object value)
public AuthRequirement.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
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. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AuthRequirement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final AuthRequirement.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AuthRequirement.Builder |
|