public sealed class UsageRule : IMessage<UsageRule>, IEquatable<UsageRule>, IDeepCloneable<UsageRule>, IBufferMessage, IMessage
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
Implements
IMessage UsageRule , IEquatable UsageRule , IDeepCloneable UsageRule , IBufferMessage , IMessageNamespace
Google.ApiAssembly
Google.Api.CommonProtos.dll
Constructors
UsageRule()
public UsageRule()
UsageRule(UsageRule)
public UsageRule(UsageRule other)
Fields
AllowUnregisteredCallsFieldNumber
public
const
int
AllowUnregisteredCallsFieldNumber
=
2
Field number for the "allow_unregistered_calls" field.
SelectorFieldNumber
public
const
int
SelectorFieldNumber
=
1
Field number for the "selector" field.
SkipServiceControlFieldNumber
public
const
int
SkipServiceControlFieldNumber
=
3
Field number for the "skip_service_control" field.
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.
Descriptor
public static MessageDescriptor Descriptor { get; }
Parser
public static 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.
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.
Methods
CalculateSize()
public int CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
The number of bytes required to write this message to a coded output stream.
Clone()
public UsageRule Clone()
Creates a deep clone of this object.
Equals(UsageRule)
public bool Equals(UsageRule other)
Equals(object)
public override bool Equals(object other)
GetHashCode()
public override int GetHashCode()
MergeFrom(UsageRule)
public void MergeFrom(UsageRule other)
Merges the given message into this one.
See the user guide for precise merge semantics.
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)
Merges the data from the specified coded input stream with the current message.
See the user guide for precise merge semantics.
ToString()
public override string ToString()
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Writes the data to the given coded output stream.
output
