Package 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
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
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 TypeMethodDescriptionboolean
boolean
If true, the service accepts API keys without any other credential.static AuthenticationRule
static final com.google.protobuf.Descriptors.Descriptor
getOauth()
The requirements for OAuth credentials.The requirements for OAuth credentials.com.google.protobuf.Parser<AuthenticationRule>
getRequirements
(int index) Requirements for additional authentication providers.int
Requirements for additional authentication providers.Requirements for additional authentication providers.getRequirementsOrBuilder
(int index) Requirements for additional authentication providers.List<? extends AuthRequirementOrBuilder>
Requirements for additional authentication providers.Selects the methods to which this rule applies.com.google.protobuf.ByteString
Selects the methods to which this rule applies.int
int
hashCode()
boolean
hasOauth()
The requirements for OAuth credentials.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static AuthenticationRule.Builder
static AuthenticationRule.Builder
newBuilder
(AuthenticationRule prototype) protected AuthenticationRule.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static AuthenticationRule
parseDelimitedFrom
(InputStream input) static AuthenticationRule
parseDelimitedFrom
(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
(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
(InputStream input) static AuthenticationRule
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AuthenticationRule
parseFrom
(ByteBuffer data) static AuthenticationRule
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<AuthenticationRule>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER- See Also:
-
OAUTH_FIELD_NUMBER
public static final int OAUTH_FIELD_NUMBER- See Also:
-
ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
public static final int ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER- See Also:
-
REQUIREMENTS_FIELD_NUMBER
public static final int REQUIREMENTS_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
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 interfaceAuthenticationRuleOrBuilder
- Returns:
- The selector.
-
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 interfaceAuthenticationRuleOrBuilder
- Returns:
- The bytes for selector.
-
hasOauth
public boolean hasOauth()The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
- Specified by:
hasOauth
in interfaceAuthenticationRuleOrBuilder
- Returns:
- Whether the oauth field is set.
-
getOauth
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
- Specified by:
getOauth
in interfaceAuthenticationRuleOrBuilder
- Returns:
- The oauth.
-
getOauthOrBuilder
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
- Specified by:
getOauthOrBuilder
in interfaceAuthenticationRuleOrBuilder
-
getAllowWithoutCredential
public boolean getAllowWithoutCredential()If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
bool allow_without_credential = 5;
- Specified by:
getAllowWithoutCredential
in interfaceAuthenticationRuleOrBuilder
- Returns:
- The allowWithoutCredential.
-
getRequirementsList
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsList
in interfaceAuthenticationRuleOrBuilder
-
getRequirementsOrBuilderList
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsOrBuilderList
in interfaceAuthenticationRuleOrBuilder
-
getRequirementsCount
public int getRequirementsCount()Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsCount
in interfaceAuthenticationRuleOrBuilder
-
getRequirements
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirements
in interfaceAuthenticationRuleOrBuilder
-
getRequirementsOrBuilder
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsOrBuilder
in interfaceAuthenticationRuleOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static AuthenticationRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AuthenticationRule parseFrom(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
- Throws:
IOException
-
parseFrom
public static AuthenticationRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static AuthenticationRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AuthenticationRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-