public final class AuthenticationRule extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
public static final int ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OAUTH_FIELD_NUMBER
public static final int OAUTH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REQUIREMENTS_FIELD_NUMBER
public static final int REQUIREMENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AuthenticationRule getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AuthenticationRule.Builder newBuilder()
newBuilder(AuthenticationRule prototype)
public static AuthenticationRule.Builder newBuilder(AuthenticationRule prototype)
public static AuthenticationRule parseDelimitedFrom(InputStream input)
public static AuthenticationRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AuthenticationRule parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AuthenticationRule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(CodedInputStream input)
public static AuthenticationRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(InputStream input)
public static AuthenticationRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AuthenticationRule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AuthenticationRule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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;
| Returns |
|---|
| Type | Description |
boolean | The allowWithoutCredential.
|
getDefaultInstanceForType()
public AuthenticationRule getDefaultInstanceForType()
getOauth()
public OAuthRequirements getOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
getOauthOrBuilder()
public OAuthRequirementsOrBuilder getOauthOrBuilder()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
getParserForType()
public Parser<AuthenticationRule> getParserForType()
Overrides
getRequirements(int index)
public AuthRequirement getRequirements(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Parameter |
|---|
| Name | Description |
index | int
|
getRequirementsCount()
public int getRequirementsCount()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Returns |
|---|
| Type | Description |
int | |
getRequirementsList()
public List<AuthRequirement> getRequirementsList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsOrBuilder(int index)
public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Parameter |
|---|
| Name | Description |
index | int
|
getRequirementsOrBuilderList()
public List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Returns |
|---|
| Type | Description |
List<? extends com.google.api.AuthRequirementOrBuilder> | |
getSelector()
public String getSelector()
Selects the methods to which this rule applies.
Refer to selector for syntax
details.
string selector = 1;
| Returns |
|---|
| Type | Description |
String | The selector.
|
getSelectorBytes()
public ByteString getSelectorBytes()
Selects the methods to which this rule applies.
Refer to selector for syntax
details.
string selector = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for selector.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hasOauth()
public boolean hasOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the oauth field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AuthenticationRule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthenticationRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AuthenticationRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
