Package com.google.api

Interface UsageRuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UsageRule, UsageRule.Builder
@Generated public interface UsageRuleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowUnregisteredCalls()
    Use this rule to configure unregistered calls for the service.
    String
    getSelector()
    Selects the methods to which this rule applies.
    com.google.protobuf.ByteString
    getSelectorBytes()
    Selects the methods to which this rule applies.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSelector

      String getSelector()
       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.
      string selector = 1;
      Returns:
      The selector.

    • getSelectorBytes

      com.google.protobuf.ByteString getSelectorBytes()
       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.
      string selector = 1;
      Returns:
      The bytes for selector.

    • getAllowUnregisteredCalls

      boolean getAllowUnregisteredCalls()
       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).

 WARNING: By default, API methods do not allow unregistered calls, and each
 method call must be identified by a consumer project identity.
      bool allow_unregistered_calls = 2;
      Returns:
      The allowUnregisteredCalls.

    • getSkipServiceControl

      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:
      The skipServiceControl.