Class Authentication (2.36.0)

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

Static Fields

PROVIDERS_FIELD_NUMBER

public static final int PROVIDERS_FIELD_NUMBER
Field Value
TypeDescription
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Authentication getDefaultInstance()
Returns
TypeDescription
Authentication

getDescriptor()

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

newBuilder()

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

newBuilder(Authentication prototype)

public static Authentication.Builder newBuilder(Authentication prototype)
Parameter
NameDescription
prototypeAuthentication
Returns
TypeDescription
Authentication.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Authentication getDefaultInstanceForType()
Returns
TypeDescription
Authentication

getParserForType()

public Parser<Authentication> getParserForType()
Returns
TypeDescription
Parser<Authentication>
Overrides

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
NameDescription
indexint
Returns
TypeDescription
AuthProvider

getProvidersCount()

public int getProvidersCount()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
TypeDescription
int

getProvidersList()

public List<AuthProvider> getProvidersList()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
AuthProviderOrBuilder

getProvidersOrBuilderList()

public List<? extends AuthProviderOrBuilder> getProvidersOrBuilderList()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.api.AuthenticationRuleOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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 Authentication.Builder newBuilderForType()
Returns
TypeDescription
Authentication.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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