final case class AuthenticationRule(selector: String = "", oauth: Option[OAuthRequirements] = _root_.scala.None, allowWithoutCredential: Boolean = false, requirements: Seq[AuthRequirement] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AuthenticationRule] with Product with Serializable

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.

selector

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

oauth

The requirements for OAuth credentials.

allowWithoutCredential

If true, the service accepts API keys without any other credential.

requirements

Requirements for additional authentication providers.

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[AuthenticationRule], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthenticationRule
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AuthenticationRule(selector: String = "", oauth: Option[OAuthRequirements] = _root_.scala.None, allowWithoutCredential: Boolean = false, requirements: Seq[AuthRequirement] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    selector

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

    oauth

    The requirements for OAuth credentials.

    allowWithoutCredential

    If true, the service accepts API keys without any other credential.

    requirements

    Requirements for additional authentication providers.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllRequirements(__vs: Iterable[AuthRequirement]): AuthenticationRule
  5. def addRequirements(__vs: AuthRequirement*): AuthenticationRule
  6. val allowWithoutCredential: Boolean
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clearOauth: AuthenticationRule
  9. def clearRequirements: AuthenticationRule
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def companion: AuthenticationRule
    Definition Classes
    AuthenticationRule → GeneratedMessage
  12. def discardUnknownFields: AuthenticationRule
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    AuthenticationRule → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    AuthenticationRule → GeneratedMessage
  18. def getOauth: OAuthRequirements
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. val oauth: Option[OAuthRequirements]
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val requirements: Seq[AuthRequirement]
  26. val selector: String
  27. def serializedSize: Int
    Definition Classes
    AuthenticationRule → GeneratedMessage
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  30. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  31. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  32. def toProtoString: String
    Definition Classes
    AuthenticationRule → GeneratedMessage
  33. val unknownFields: UnknownFieldSet
  34. def update(ms: (Lens[AuthenticationRule, AuthenticationRule]) => Mutation[AuthenticationRule]*): AuthenticationRule
    Definition Classes
    Updatable
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. def withAllowWithoutCredential(__v: Boolean): AuthenticationRule
  39. def withOauth(__v: OAuthRequirements): AuthenticationRule
  40. def withRequirements(__v: Seq[AuthRequirement]): AuthenticationRule
  41. def withSelector(__v: String): AuthenticationRule
  42. def withUnknownFields(__v: UnknownFieldSet): AuthenticationRule
  43. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  44. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    AuthenticationRule → GeneratedMessage
  45. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[AuthenticationRule]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped