public static final class Authentication.Builder extends GeneratedMessageV3.Builder<Authentication.Builder> implements AuthenticationOrBuilder
`Authentication` defines the authentication configuration for an API.
Example for an API targeted for external use:
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
Protobuf type google.api.Authentication| Modifier and Type | Method and Description |
|---|---|
Authentication.Builder |
addAllProviders(java.lang.Iterable<? extends AuthProvider> values)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
addAllRules(java.lang.Iterable<? extends AuthenticationRule> values)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
addProviders(AuthProvider.Builder builderForValue)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
addProviders(AuthProvider value)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
addProviders(int index,
AuthProvider.Builder builderForValue)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
addProviders(int index,
AuthProvider value)
Defines a set of authentication providers that a service supports.
|
AuthProvider.Builder |
addProvidersBuilder()
Defines a set of authentication providers that a service supports.
|
AuthProvider.Builder |
addProvidersBuilder(int index)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Authentication.Builder |
addRules(AuthenticationRule.Builder builderForValue)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
addRules(AuthenticationRule value)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
addRules(int index,
AuthenticationRule.Builder builderForValue)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
addRules(int index,
AuthenticationRule value)
A list of authentication rules that apply to individual API methods.
|
AuthenticationRule.Builder |
addRulesBuilder()
A list of authentication rules that apply to individual API methods.
|
AuthenticationRule.Builder |
addRulesBuilder(int index)
A list of authentication rules that apply to individual API methods.
|
Authentication |
build() |
Authentication |
buildPartial() |
Authentication.Builder |
clear() |
Authentication.Builder |
clearField(Descriptors.FieldDescriptor field) |
Authentication.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Authentication.Builder |
clearProviders()
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
clearRules()
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
clone() |
Authentication |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
AuthProvider |
getProviders(int index)
Defines a set of authentication providers that a service supports.
|
AuthProvider.Builder |
getProvidersBuilder(int index)
Defines a set of authentication providers that a service supports.
|
java.util.List<AuthProvider.Builder> |
getProvidersBuilderList()
Defines a set of authentication providers that a service supports.
|
int |
getProvidersCount()
Defines a set of authentication providers that a service supports.
|
java.util.List<AuthProvider> |
getProvidersList()
Defines a set of authentication providers that a service supports.
|
AuthProviderOrBuilder |
getProvidersOrBuilder(int index)
Defines a set of authentication providers that a service supports.
|
java.util.List<? extends AuthProviderOrBuilder> |
getProvidersOrBuilderList()
Defines a set of authentication providers that a service supports.
|
AuthenticationRule |
getRules(int index)
A list of authentication rules that apply to individual API methods.
|
AuthenticationRule.Builder |
getRulesBuilder(int index)
A list of authentication rules that apply to individual API methods.
|
java.util.List<AuthenticationRule.Builder> |
getRulesBuilderList()
A list of authentication rules that apply to individual API methods.
|
int |
getRulesCount()
A list of authentication rules that apply to individual API methods.
|
java.util.List<AuthenticationRule> |
getRulesList()
A list of authentication rules that apply to individual API methods.
|
AuthenticationRuleOrBuilder |
getRulesOrBuilder(int index)
A list of authentication rules that apply to individual API methods.
|
java.util.List<? extends AuthenticationRuleOrBuilder> |
getRulesOrBuilderList()
A list of authentication rules that apply to individual API methods.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Authentication.Builder |
mergeFrom(Authentication other) |
Authentication.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Authentication.Builder |
mergeFrom(Message other) |
Authentication.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Authentication.Builder |
removeProviders(int index)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
removeRules(int index)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Authentication.Builder |
setProviders(int index,
AuthProvider.Builder builderForValue)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
setProviders(int index,
AuthProvider value)
Defines a set of authentication providers that a service supports.
|
Authentication.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Authentication.Builder |
setRules(int index,
AuthenticationRule.Builder builderForValue)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
setRules(int index,
AuthenticationRule value)
A list of authentication rules that apply to individual API methods.
|
Authentication.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Authentication.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Authentication build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Authentication buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Authentication.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Authentication.Builder>public Authentication.Builder mergeFrom(Authentication other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Authentication.Builder>public Authentication.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Authentication.Builder>java.io.IOExceptionpublic java.util.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;getRulesList in interface AuthenticationOrBuilderpublic 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;getRulesCount in interface AuthenticationOrBuilderpublic 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;getRules in interface AuthenticationOrBuilderpublic 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;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;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;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;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;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;public Authentication.Builder addAllRules(java.lang.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;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;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;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;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;getRulesOrBuilder in interface AuthenticationOrBuilderpublic java.util.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;getRulesOrBuilderList in interface AuthenticationOrBuilderpublic 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;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;public java.util.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;public java.util.List<AuthProvider> getProvidersList()
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;getProvidersList in interface AuthenticationOrBuilderpublic int getProvidersCount()
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;getProvidersCount in interface AuthenticationOrBuilderpublic AuthProvider getProviders(int index)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;getProviders in interface AuthenticationOrBuilderpublic Authentication.Builder setProviders(int index, AuthProvider value)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;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;public Authentication.Builder addProviders(AuthProvider value)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public Authentication.Builder addProviders(int index, AuthProvider value)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public Authentication.Builder addProviders(AuthProvider.Builder builderForValue)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;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;public Authentication.Builder addAllProviders(java.lang.Iterable<? extends AuthProvider> values)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public Authentication.Builder clearProviders()
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public Authentication.Builder removeProviders(int index)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public AuthProvider.Builder getProvidersBuilder(int index)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public AuthProviderOrBuilder getProvidersOrBuilder(int index)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;getProvidersOrBuilder in interface AuthenticationOrBuilderpublic java.util.List<? extends AuthProviderOrBuilder> getProvidersOrBuilderList()
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;getProvidersOrBuilderList in interface AuthenticationOrBuilderpublic AuthProvider.Builder addProvidersBuilder()
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public AuthProvider.Builder addProvidersBuilder(int index)
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public java.util.List<AuthProvider.Builder> getProvidersBuilderList()
Defines a set of authentication providers that a service supports.
repeated .google.api.AuthProvider providers = 4;public final Authentication.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Authentication.Builder>public final Authentication.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Authentication.Builder>