Class AuthRequirement.Builder (2.30.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthRequirement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AuthRequirement.Builder
Overrides

build()

public AuthRequirement build()
Returns
TypeDescription
AuthRequirement

buildPartial()

public AuthRequirement buildPartial()
Returns
TypeDescription
AuthRequirement

clear()

public AuthRequirement.Builder clear()
Returns
TypeDescription
AuthRequirement.Builder
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;

Returns
TypeDescription
AuthRequirement.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AuthRequirement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AuthRequirement.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthRequirement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AuthRequirement.Builder
Overrides

clearProviderId()

public AuthRequirement.Builder clearProviderId()

id from authentication provider.

Example:

 provider_id: bookstore_auth

string provider_id = 1;

Returns
TypeDescription
AuthRequirement.Builder

This builder for chaining.

clone()

public AuthRequirement.Builder clone()
Returns
TypeDescription
AuthRequirement.Builder
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
TypeDescription
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
TypeDescription
ByteString

The bytes for audiences.

getDefaultInstanceForType()

public AuthRequirement getDefaultInstanceForType()
Returns
TypeDescription
AuthRequirement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getProviderId()

public String getProviderId()

id from authentication provider.

Example:

 provider_id: bookstore_auth

string provider_id = 1;

Returns
TypeDescription
String

The providerId.

getProviderIdBytes()

public ByteString getProviderIdBytes()

id from authentication provider.

Example:

 provider_id: bookstore_auth

string provider_id = 1;

Returns
TypeDescription
ByteString

The bytes for providerId.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AuthRequirement other)

public AuthRequirement.Builder mergeFrom(AuthRequirement other)
Parameter
NameDescription
otherAuthRequirement
Returns
TypeDescription
AuthRequirement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthRequirement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AuthRequirement.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AuthRequirement.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthRequirement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AuthRequirement.Builder
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
NameDescription
valueString

The audiences to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for audiences to set.

Returns
TypeDescription
AuthRequirement.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AuthRequirement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AuthRequirement.Builder
Overrides

setProviderId(String value)

public AuthRequirement.Builder setProviderId(String value)

id from authentication provider.

Example:

 provider_id: bookstore_auth

string provider_id = 1;

Parameter
NameDescription
valueString

The providerId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for providerId to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AuthRequirement.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthRequirement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AuthRequirement.Builder
Overrides