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 > AuthenticationImplements
AuthenticationOrBuilderStatic 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 | |
getDefaultInstanceForType()
public Authentication getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Authentication | |
getParserForType()
public Parser<Authentication> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Authentication> | |
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 | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Returns | |
|---|---|
| Type | Description |
UnknownFieldSet | |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public Authentication.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Authentication.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |