final case class UsageRule(selector: String = "", allowUnregisteredCalls: Boolean = false, skipServiceControl: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UsageRule] with Product with Serializable

Usage configuration rules for the service.

NOTE: Under development.

Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls.

Example of an API that wants to allow unregistered calls for entire service.

usage: rules:

  • selector: "*" allow_unregistered_calls: true

Example of a method that wants to allow unregistered calls.

usage: rules:

  • selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true
selector

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

allowUnregisteredCalls

If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

skipServiceControl

If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

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

Instance Constructors

  1. new UsageRule(selector: String = "", allowUnregisteredCalls: Boolean = false, skipServiceControl: Boolean = false, unknownFields: UnknownFieldSet = ...)

    selector

    Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

    allowUnregisteredCalls

    If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

    skipServiceControl

    If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.

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. val allowUnregisteredCalls: Boolean
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def companion: UsageRule.type
    Definition Classes
    UsageRule → GeneratedMessage
  8. def discardUnknownFields: UsageRule
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    UsageRule → GeneratedMessage
  13. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    UsageRule → GeneratedMessage
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val selector: String
  19. def serializedSize: Int
    Definition Classes
    UsageRule → GeneratedMessage
  20. val skipServiceControl: Boolean
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  23. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  24. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  25. def toProtoString: String
    Definition Classes
    UsageRule → GeneratedMessage
  26. val unknownFields: UnknownFieldSet
  27. def update(ms: (Lens[UsageRule, UsageRule]) ⇒ Mutation[UsageRule]*): UsageRule
    Definition Classes
    Updatable
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. def withAllowUnregisteredCalls(__v: Boolean): UsageRule
  32. def withSelector(__v: String): UsageRule
  33. def withSkipServiceControl(__v: Boolean): UsageRule
  34. def withUnknownFields(__v: UnknownFieldSet): UsageRule
  35. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  36. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    UsageRule → GeneratedMessage
  37. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[UsageRule]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped