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
Modifier and Type | Class and Description |
---|---|
static class |
AuthenticationRule.Builder
Authentication rules for the service.
|
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
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 |
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) |
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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int SELECTOR_FIELD_NUMBER
public static final int OAUTH_FIELD_NUMBER
public static final int ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
public static final int REQUIREMENTS_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
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;
getSelector
in interface AuthenticationRuleOrBuilder
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;
getSelectorBytes
in interface AuthenticationRuleOrBuilder
public boolean hasOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
hasOauth
in interface AuthenticationRuleOrBuilder
public OAuthRequirements getOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
getOauth
in interface AuthenticationRuleOrBuilder
public OAuthRequirementsOrBuilder getOauthOrBuilder()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
getOauthOrBuilder
in interface AuthenticationRuleOrBuilder
public boolean getAllowWithoutCredential()
If true, the service accepts API keys without any other credential.
bool allow_without_credential = 5;
getAllowWithoutCredential
in interface AuthenticationRuleOrBuilder
public java.util.List<AuthRequirement> getRequirementsList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsList
in interface AuthenticationRuleOrBuilder
public java.util.List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsOrBuilderList
in interface AuthenticationRuleOrBuilder
public int getRequirementsCount()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsCount
in interface AuthenticationRuleOrBuilder
public AuthRequirement getRequirements(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirements
in interface AuthenticationRuleOrBuilder
public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsOrBuilder
in interface AuthenticationRuleOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static AuthenticationRule parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationRule parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static AuthenticationRule parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static AuthenticationRule parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static AuthenticationRule parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static AuthenticationRule parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public AuthenticationRule.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static AuthenticationRule.Builder newBuilder()
public static AuthenticationRule.Builder newBuilder(AuthenticationRule prototype)
public AuthenticationRule.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected AuthenticationRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static AuthenticationRule getDefaultInstance()
public static com.google.protobuf.Parser<AuthenticationRule> parser()
public com.google.protobuf.Parser<AuthenticationRule> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public AuthenticationRule getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder