Class Authentication.Builder (2.24.0)

Version 2.24.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 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 static final class Authentication.Builder extends GeneratedMessageV3.Builder<Authentication.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Authentication.Builder

Implements

AuthenticationOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllProviders(Iterable<? extends AuthProvider> values)

public Authentication.Builder addAllProviders(Iterable<? extends AuthProvider> values)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameter
Name	Description
values	Iterable<? extends com.google.api.AuthProvider>

Returns
Type	Description
Authentication.Builder

addAllRules(Iterable<? extends AuthenticationRule> values)

public Authentication.Builder addAllRules(Iterable<? extends AuthenticationRule> values)

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
values	Iterable<? extends com.google.api.AuthenticationRule>

Returns
Type	Description
Authentication.Builder

addProviders(AuthProvider value)

public Authentication.Builder addProviders(AuthProvider value)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameter
Name	Description
value	AuthProvider

Returns
Type	Description
Authentication.Builder

addProviders(AuthProvider.Builder builderForValue)

public Authentication.Builder addProviders(AuthProvider.Builder builderForValue)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameter
Name	Description
builderForValue	AuthProvider.Builder

Returns
Type	Description
Authentication.Builder

addProviders(int index, AuthProvider value)

public Authentication.Builder addProviders(int index, AuthProvider value)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameters
Name	Description
index	int
value	AuthProvider

Returns
Type	Description
Authentication.Builder

addProviders(int index, AuthProvider.Builder builderForValue)

public Authentication.Builder addProviders(int index, AuthProvider.Builder builderForValue)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameters
Name	Description
index	int
builderForValue	AuthProvider.Builder

Returns
Type	Description
Authentication.Builder

addProvidersBuilder()

public AuthProvider.Builder addProvidersBuilder()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
Type	Description
AuthProvider.Builder

addProvidersBuilder(int index)

public AuthProvider.Builder addProvidersBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Authentication.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRules(AuthenticationRule value)

public Authentication.Builder addRules(AuthenticationRule value)

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
value	AuthenticationRule

Returns
Type	Description
Authentication.Builder

addRules(AuthenticationRule.Builder builderForValue)

public Authentication.Builder addRules(AuthenticationRule.Builder builderForValue)

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
builderForValue	AuthenticationRule.Builder

Returns
Type	Description
Authentication.Builder

addRules(int index, AuthenticationRule value)

public Authentication.Builder addRules(int index, AuthenticationRule value)

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;

Parameters
Name	Description
index	int
value	AuthenticationRule

Returns
Type	Description
Authentication.Builder

addRules(int index, AuthenticationRule.Builder builderForValue)

public Authentication.Builder addRules(int index, AuthenticationRule.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	AuthenticationRule.Builder

Returns
Type	Description
Authentication.Builder

addRulesBuilder()

public AuthenticationRule.Builder addRulesBuilder()

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
AuthenticationRule.Builder

addRulesBuilder(int index)

public AuthenticationRule.Builder addRulesBuilder(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.Builder

build()

public Authentication build()

Returns
Type	Description
Authentication

buildPartial()

public Authentication buildPartial()

Returns
Type	Description
Authentication

clear()

public Authentication.Builder clear()

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Authentication.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Authentication.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProviders()

public Authentication.Builder clearProviders()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
Type	Description
Authentication.Builder

clearRules()

public Authentication.Builder clearRules()

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
Authentication.Builder

clone()

public Authentication.Builder clone()

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Authentication getDefaultInstanceForType()

Returns
Type	Description
Authentication

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

getProvidersBuilder(int index)

public AuthProvider.Builder getProvidersBuilder(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.Builder

getProvidersBuilderList()

public List<AuthProvider.Builder> getProvidersBuilderList()

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Returns
Type	Description
List<Builder>

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

getRulesBuilder(int index)

public AuthenticationRule.Builder getRulesBuilder(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.Builder

getRulesBuilderList()

public List<AuthenticationRule.Builder> getRulesBuilderList()

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<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Authentication other)

public Authentication.Builder mergeFrom(Authentication other)

Parameter
Name	Description
other	Authentication

Returns
Type	Description
Authentication.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Authentication.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Authentication.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Authentication.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Authentication.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeProviders(int index)

public Authentication.Builder removeProviders(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
Authentication.Builder

removeRules(int index)

public Authentication.Builder removeRules(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
Authentication.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Authentication.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setProviders(int index, AuthProvider value)

public Authentication.Builder setProviders(int index, AuthProvider value)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameters
Name	Description
index	int
value	AuthProvider

Returns
Type	Description
Authentication.Builder

setProviders(int index, AuthProvider.Builder builderForValue)

public Authentication.Builder setProviders(int index, AuthProvider.Builder builderForValue)

Defines a set of authentication providers that a service supports.

repeated .google.api.AuthProvider providers = 4;

Parameters
Name	Description
index	int
builderForValue	AuthProvider.Builder

Returns
Type	Description
Authentication.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Authentication.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRules(int index, AuthenticationRule value)

public Authentication.Builder setRules(int index, AuthenticationRule value)

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;

Parameters
Name	Description
index	int
value	AuthenticationRule

Returns
Type	Description
Authentication.Builder

setRules(int index, AuthenticationRule.Builder builderForValue)

public Authentication.Builder setRules(int index, AuthenticationRule.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	AuthenticationRule.Builder

Returns
Type	Description
Authentication.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Authentication.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)