Class AuthenticationRule (2.8.4) 

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AuthenticationRule

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()
Returns
Type Description
AuthenticationRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AuthenticationRule.Builder newBuilder()
Returns
Type Description
AuthenticationRule.Builder

newBuilder(AuthenticationRule prototype)

public static AuthenticationRule.Builder newBuilder(AuthenticationRule prototype)
Parameter
Name Description
prototype AuthenticationRule
Returns
Type Description
AuthenticationRule.Builder

parseDelimitedFrom(InputStream input)

public static AuthenticationRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthenticationRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AuthenticationRule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuthenticationRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuthenticationRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuthenticationRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuthenticationRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthenticationRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AuthenticationRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuthenticationRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AuthenticationRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuthenticationRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthenticationRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AuthenticationRule> parser()
Returns
Type Description
Parser<AuthenticationRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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