Class Authentication (2.23.1)

Version 2.23.1

• 2.48.0 (latest)
• 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 final class Authentication extends GeneratedMessageV3 implements AuthenticationOrBuilder

Authentication defines the authentication configuration for API methods provided by an API service.

Example:

 name: calendar.googleapis.com
 authentication:
   providers:
   - id: google_calendar_auth
     jwks_uri: https://www.googleapis.com/oauth2/v1/certs
     issuer: https://securetoken.google.com
   rules:
   - selector: "*"
     requirements:
       provider_id: google_calendar_auth
   - selector: google.calendar.Delegate
     oauth:
       canonical_scopes: https://www.googleapis.com/auth/calendar.read

Protobuf type google.api.Authentication

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Authentication

Implements

AuthenticationOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

PROVIDERS_FIELD_NUMBER

public static final int PROVIDERS_FIELD_NUMBER

Field Value
Type	Description
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Authentication getDefaultInstance()

Returns
Type	Description
Authentication

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Authentication.Builder newBuilder()

Returns
Type	Description
Authentication.Builder

newBuilder(Authentication prototype)

public static Authentication.Builder newBuilder(Authentication prototype)

Parameter
Name	Description
prototype	Authentication

Returns
Type	Description
Authentication.Builder

parseDelimitedFrom(InputStream input)

public static Authentication parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Authentication

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Authentication parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Authentication parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Authentication

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Authentication parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Authentication

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Authentication parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Authentication

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Authentication parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Authentication

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Authentication parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Authentication

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Authentication parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Authentication> parser()

Returns
Type	Description
Parser<Authentication>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Authentication getDefaultInstanceForType()

Returns
Type	Description
Authentication

getParserForType()

public Parser<Authentication> getParserForType()

Returns
Type	Description
Parser<Authentication>

Overrides

GeneratedMessageV3.getParserForType()

getProviders(int index)

public AuthProvider getProviders(int index)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthProvider

getProvidersCount()

public int getProvidersCount()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
Type	Description
int

getProvidersList()

public List<AuthProvider> getProvidersList()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
Type	Description
List<AuthProvider>

getProvidersOrBuilder(int index)

public AuthProviderOrBuilder getProvidersOrBuilder(int index)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthProviderOrBuilder

getProvidersOrBuilderList()

public List<? extends AuthProviderOrBuilder> getProvidersOrBuilderList()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
Type	Description
List<? extends com.google.api.AuthProviderOrBuilder>

getRules(int index)

public AuthenticationRule getRules(int index)

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.AuthenticationRule rules = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthenticationRule

getRulesCount()

public int getRulesCount()

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.AuthenticationRule rules = 3;

Returns
Type	Description
int

getRulesList()

public List<AuthenticationRule> getRulesList()

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.AuthenticationRule rules = 3;

Returns
Type	Description
List<AuthenticationRule>

getRulesOrBuilder(int index)

public AuthenticationRuleOrBuilder getRulesOrBuilder(int index)

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.AuthenticationRule rules = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthenticationRuleOrBuilder

getRulesOrBuilderList()

public List<? extends AuthenticationRuleOrBuilder> getRulesOrBuilderList()

A list of authentication rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

repeated .google.api.AuthenticationRule rules = 3;

Returns
Type	Description
List<? extends com.google.api.AuthenticationRuleOrBuilder>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Authentication.Builder newBuilderForType()

Returns
Type	Description
Authentication.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Authentication.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Authentication.Builder toBuilder()

Returns
Type	Description
Authentication.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException