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.BuilderImplements
AuthenticationOrBuilderStatic 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 | |
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 | |
clearField(Descriptors.FieldDescriptor field)
public Authentication.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Authentication.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public Authentication.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Authentication.Builder | |
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 | |
getDefaultInstanceForType()
public Authentication getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Authentication | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Authentication.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Authentication.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Authentication.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Authentication.Builder | |
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 | |
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 | |
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 | |