Class AuthRequirement (2.9.1)

Stay organized with collections Save and categorize content based on your preferences.
public final class AuthRequirement extends GeneratedMessageV3 implements AuthRequirementOrBuilder

User-defined authentication requirements, including support for JSON Web Token (JWT).

Protobuf type google.api.AuthRequirement

Static Fields

AUDIENCES_FIELD_NUMBER

public static final int AUDIENCES_FIELD_NUMBER
Field Value
TypeDescription
int

PROVIDER_ID_FIELD_NUMBER

public static final int PROVIDER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AuthRequirement getDefaultInstance()
Returns
TypeDescription
AuthRequirement

getDescriptor()

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

newBuilder()

public static AuthRequirement.Builder newBuilder()
Returns
TypeDescription
AuthRequirement.Builder

newBuilder(AuthRequirement prototype)

public static AuthRequirement.Builder newBuilder(AuthRequirement prototype)
Parameter
NameDescription
prototypeAuthRequirement
Returns
TypeDescription
AuthRequirement.Builder

parseDelimitedFrom(InputStream input)

public static AuthRequirement parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthRequirement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AuthRequirement parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthRequirement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthRequirement parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthRequirement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthRequirement parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthRequirement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AuthRequirement parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthRequirement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AuthRequirement parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthRequirement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthRequirement
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AuthRequirement> parser()
Returns
TypeDescription
Parser<AuthRequirement>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

getParserForType()

public Parser<AuthRequirement> getParserForType()
Returns
TypeDescription
Parser<AuthRequirement>
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AuthRequirement.Builder newBuilderForType()
Returns
TypeDescription
AuthRequirement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AuthRequirement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AuthRequirement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AuthRequirement.Builder toBuilder()
Returns
TypeDescription
AuthRequirement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException