AuthenticationRule

com.google.api.auth.AuthenticationRule
See theAuthenticationRule companion object
final case class AuthenticationRule(selector: String, oauth: Option[OAuthRequirements], allowWithoutCredential: Boolean, requirements: Seq[AuthRequirement], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[AuthenticationRule]

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.

Attributes

allowWithoutCredential

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth

The requirements for OAuth credentials.

requirements

Requirements for additional authentication providers.

selector

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

Companion:
object
Source:
AuthenticationRule.scala
Graph
Supertypes
trait Updatable[AuthenticationRule]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
AuthenticationRule.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
AuthenticationRule.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
AuthenticationRule.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
AuthenticationRule.scala
def withUnknownFields(`__v`: UnknownFieldSet): AuthenticationRule

Attributes

Source:
AuthenticationRule.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
AuthenticationRule.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala