Send feedback
Class UsageRule (2.28.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.28.0 keyboard_arrow_down
public final class UsageRule extends GeneratedMessageV3 implements UsageRuleOrBuilder
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
Protobuf type google.api.UsageRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
ALLOW_UNREGISTERED_CALLS_FIELD_NUMBER
public static final int ALLOW_UNREGISTERED_CALLS_FIELD_NUMBER
Field Value Type Description int
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
Field Value Type Description int
SKIP_SERVICE_CONTROL_FIELD_NUMBER
public static final int SKIP_SERVICE_CONTROL_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static UsageRule getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static UsageRule . Builder newBuilder ()
newBuilder(UsageRule prototype)
public static UsageRule . Builder newBuilder ( UsageRule prototype )
public static UsageRule parseDelimitedFrom ( InputStream input )
public static UsageRule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static UsageRule parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UsageRule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static UsageRule parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UsageRule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static UsageRule parseFrom ( CodedInputStream input )
public static UsageRule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static UsageRule parseFrom ( InputStream input )
public static UsageRule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static UsageRule parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UsageRule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<UsageRule> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getAllowUnregisteredCalls()
public boolean getAllowUnregisteredCalls ()
If true, the selected method allows unregistered calls, e.g. calls
that don't identify any user or application.
bool allow_unregistered_calls = 2;
Returns Type Description boolean The allowUnregisteredCalls.
getDefaultInstanceForType()
public UsageRule getDefaultInstanceForType ()
getParserForType()
public Parser<UsageRule> getParserForType ()
Overrides
getSelector()
public String getSelector ()
Selects the methods to which this rule applies. Use '*' to indicate all
methods in all APIs.
Refer to selector for syntax
details.
string selector = 1;
Returns Type Description String The selector.
getSelectorBytes()
public ByteString getSelectorBytes ()
Selects the methods to which this rule applies. Use '*' to indicate all
methods in all APIs.
Refer to selector for syntax
details.
string selector = 1;
Returns Type Description ByteString The bytes for selector.
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getSkipServiceControl()
public boolean getSkipServiceControl ()
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.
bool skip_service_control = 3;
Returns Type Description boolean The skipServiceControl.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public UsageRule . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UsageRule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public UsageRule . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
