public sealed class UsageRule : Protobuf.IMessage<UsageRule>, Protobuf.IBufferMessage
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
Inheritance
Object >
UsageRule
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
UsageRule()
UsageRule(UsageRule)
public UsageRule(UsageRule other)
Fields
AllowUnregisteredCallsFieldNumber
public const int AllowUnregisteredCallsFieldNumber = 2
Field number for the "allow_unregistered_calls" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
SelectorFieldNumber
public const int SelectorFieldNumber = 1
Field number for the "selector" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
SkipServiceControlFieldNumber
public const int SkipServiceControlFieldNumber = 3
Field number for the "skip_service_control" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
Properties
AllowUnregisteredCalls
public bool AllowUnregisteredCalls { get; set; }
If true, the selected method allows unregistered calls, e.g. calls
that don't identify any user or application.
| Property Value |
|---|
| Type | Description |
Boolean | |
Descriptor
public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Parser
public static Protobuf.MessageParser<UsageRule> Parser { get; }
Selector
public string Selector { get; set; }
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.
| Property Value |
|---|
| Type | Description |
String | |
SkipServiceControl
public bool SkipServiceControl { get; set; }
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.
| Property Value |
|---|
| Type | Description |
Boolean | |
Methods
CalculateSize()
public int CalculateSize()
| Returns |
|---|
| Type | Description |
Int32 | |
Clone()
Equals(UsageRule)
public bool Equals(UsageRule other)
Equals(Object)
public override bool Equals(object other)
| Parameter |
|---|
| Name | Description |
other | Object
|
GetHashCode()
public override int GetHashCode()
| Returns |
|---|
| Type | Description |
Int32 | |
MergeFrom(UsageRule)
public void MergeFrom(UsageRule other)
public void MergeFrom(Protobuf.CodedInputStream input)
ToString()
public override string ToString()
WriteTo(Protobuf.CodedOutputStream)
public void WriteTo(Protobuf.CodedOutputStream output)
