public static final class AuthRequirement.Builder extends GeneratedMessageV3.Builder<AuthRequirement.Builder> implements AuthRequirementOrBuilder
User-defined authentication requirements, including support for
JSON Web Token
(JWT).
Protobuf type google.api.AuthRequirement
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AuthRequirement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public AuthRequirement build()
buildPartial()
public AuthRequirement buildPartial()
clear()
public AuthRequirement.Builder clear()
Overrides
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;
clearField(Descriptors.FieldDescriptor field)
public AuthRequirement.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public AuthRequirement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearProviderId()
public AuthRequirement.Builder clearProviderId()
id from authentication provider.
Example:
provider_id: bookstore_auth
string provider_id = 1;
clone()
public AuthRequirement.Builder clone()
Overrides
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(AuthRequirement other)
public AuthRequirement.Builder mergeFrom(AuthRequirement other)
public AuthRequirement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public AuthRequirement.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AuthRequirement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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 | String
The audiences to set.
|
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 | ByteString
The bytes for audiences to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public AuthRequirement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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 | String
The providerId to set.
|
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 | ByteString
The bytes for providerId to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AuthRequirement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final AuthRequirement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
