com.google.api

Class AuthenticationRule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.AuthenticationRule

All Implemented Interfaces:

AuthenticationRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class AuthenticationRule
extends com.google.protobuf.GeneratedMessageV3
implements AuthenticationRuleOrBuilder

 Authentication rules for the service.
 By default, if a method has any authentication requirements, every request
 must include a valid credential matching one of the requirements.
 It's an error to include more than one kind of credential in a single
 request.
 If a method doesn't have any auth requirements, request credentials will be
 ignored.
 

Protobuf type google.api.AuthenticationRule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationRule.Builder Authentication rules for the service.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
static int	OAUTH_FIELD_NUMBER
static int	REQUIREMENTS_FIELD_NUMBER
static int	SELECTOR_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	getAllowWithoutCredential() If true, the service accepts API keys without any other credential.
static AuthenticationRule	getDefaultInstance()
AuthenticationRule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
OAuthRequirements	getOauth() The requirements for OAuth credentials.
OAuthRequirementsOrBuilder	getOauthOrBuilder() The requirements for OAuth credentials.
com.google.protobuf.Parser<AuthenticationRule>	getParserForType()
AuthRequirement	getRequirements(int index) Requirements for additional authentication providers.
int	getRequirementsCount() Requirements for additional authentication providers.
java.util.List<AuthRequirement>	getRequirementsList() Requirements for additional authentication providers.
AuthRequirementOrBuilder	getRequirementsOrBuilder(int index) Requirements for additional authentication providers.
java.util.List<? extends AuthRequirementOrBuilder>	getRequirementsOrBuilderList() Requirements for additional authentication providers.
java.lang.String	getSelector() Selects the methods to which this rule applies.
com.google.protobuf.ByteString	getSelectorBytes() Selects the methods to which this rule applies.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasOauth() The requirements for OAuth credentials.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AuthenticationRule.Builder	newBuilder()
static AuthenticationRule.Builder	newBuilder(AuthenticationRule prototype)
AuthenticationRule.Builder	newBuilderForType()
protected AuthenticationRule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static AuthenticationRule	parseDelimitedFrom(java.io.InputStream input)
static AuthenticationRule	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthenticationRule	parseFrom(byte[] data)
static AuthenticationRule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthenticationRule	parseFrom(java.nio.ByteBuffer data)
static AuthenticationRule	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthenticationRule	parseFrom(com.google.protobuf.ByteString data)
static AuthenticationRule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthenticationRule	parseFrom(com.google.protobuf.CodedInputStream input)
static AuthenticationRule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthenticationRule	parseFrom(java.io.InputStream input)
static AuthenticationRule	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AuthenticationRule>	parser()
AuthenticationRule.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER

See Also:

Constant Field Values

OAUTH_FIELD_NUMBER

public static final int OAUTH_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER

public static final int ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER

See Also:

Constant Field Values

REQUIREMENTS_FIELD_NUMBER

public static final int REQUIREMENTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSelector

public java.lang.String getSelector()

 Selects the methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
 

string selector = 1;

Specified by:

getSelector in interface AuthenticationRuleOrBuilder

getSelectorBytes

public com.google.protobuf.ByteString getSelectorBytes()

 Selects the methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
 

string selector = 1;

Specified by:

getSelectorBytes in interface AuthenticationRuleOrBuilder

hasOauth

public boolean hasOauth()

 The requirements for OAuth credentials.
 

.google.api.OAuthRequirements oauth = 2;

Specified by:

hasOauth in interface AuthenticationRuleOrBuilder

getOauth

public OAuthRequirements getOauth()

 The requirements for OAuth credentials.
 

.google.api.OAuthRequirements oauth = 2;

Specified by:

getOauth in interface AuthenticationRuleOrBuilder

getOauthOrBuilder

public OAuthRequirementsOrBuilder getOauthOrBuilder()

 The requirements for OAuth credentials.
 

.google.api.OAuthRequirements oauth = 2;

Specified by:

getOauthOrBuilder in interface AuthenticationRuleOrBuilder

getAllowWithoutCredential

public boolean getAllowWithoutCredential()

 If true, the service accepts API keys without any other credential.
 

bool allow_without_credential = 5;

Specified by:

getAllowWithoutCredential in interface AuthenticationRuleOrBuilder

getRequirementsList

public java.util.List<AuthRequirement> getRequirementsList()

 Requirements for additional authentication providers.
 

repeated .google.api.AuthRequirement requirements = 7;

Specified by:

getRequirementsList in interface AuthenticationRuleOrBuilder

getRequirementsOrBuilderList

public java.util.List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()

 Requirements for additional authentication providers.
 

repeated .google.api.AuthRequirement requirements = 7;

Specified by:

getRequirementsOrBuilderList in interface AuthenticationRuleOrBuilder

getRequirementsCount

public int getRequirementsCount()

 Requirements for additional authentication providers.
 

repeated .google.api.AuthRequirement requirements = 7;

Specified by:

getRequirementsCount in interface AuthenticationRuleOrBuilder

getRequirements

public AuthRequirement getRequirements(int index)

 Requirements for additional authentication providers.
 

repeated .google.api.AuthRequirement requirements = 7;

Specified by:

getRequirements in interface AuthenticationRuleOrBuilder

getRequirementsOrBuilder

public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)

 Requirements for additional authentication providers.
 

repeated .google.api.AuthRequirement requirements = 7;

Specified by:

getRequirementsOrBuilder in interface AuthenticationRuleOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AuthenticationRule parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AuthenticationRule parseFrom(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AuthenticationRule parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AuthenticationRule parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AuthenticationRule parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AuthenticationRule parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AuthenticationRule parseFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AuthenticationRule parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static AuthenticationRule parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static AuthenticationRule parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public AuthenticationRule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AuthenticationRule.Builder newBuilder()

newBuilder

public static AuthenticationRule.Builder newBuilder(AuthenticationRule prototype)

toBuilder

public AuthenticationRule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AuthenticationRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AuthenticationRule getDefaultInstance()

parser

public static com.google.protobuf.Parser<AuthenticationRule> parser()

getParserForType

public com.google.protobuf.Parser<AuthenticationRule> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AuthenticationRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder