Package com.google.api

Class UsageRule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>
com.google.api.UsageRule.Builder
All Implemented Interfaces:
UsageRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
UsageRule
public static final class UsageRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder> 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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • clear

      public UsageRule.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • getDefaultInstanceForType

      public UsageRule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public UsageRule build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public UsageRule buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public UsageRule.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • setField

      public UsageRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • clearField

      public UsageRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • clearOneof

      public UsageRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • setRepeatedField

      public UsageRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • addRepeatedField

      public UsageRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • mergeFrom

      public UsageRule.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UsageRule.Builder>

    • mergeFrom

      public UsageRule.Builder mergeFrom(UsageRule other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • mergeFrom

      public UsageRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UsageRule.Builder>
      Throws:
      IOException

    • getSelector

      public 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;
      Specified by:
      getSelector in interface UsageRuleOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public 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;
      Specified by:
      getSelectorBytes in interface UsageRuleOrBuilder
      Returns:
      The bytes for selector.

    • setSelector

      public UsageRule.Builder setSelector(String value)
       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;
      Parameters:
      value - The selector to set.
      Returns:
      This builder for chaining.

    • clearSelector

      public UsageRule.Builder clearSelector()
       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:
      This builder for chaining.

    • setSelectorBytes

      public UsageRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for selector to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getAllowUnregisteredCalls in interface UsageRuleOrBuilder
      Returns:
      The allowUnregisteredCalls.

    • setAllowUnregisteredCalls

      public UsageRule.Builder setAllowUnregisteredCalls(boolean value)
       If true, the selected method allows unregistered calls, e.g. calls
 that don't identify any user or application.
      bool allow_unregistered_calls = 2;
      Parameters:
      value - The allowUnregisteredCalls to set.
      Returns:
      This builder for chaining.

    • clearAllowUnregisteredCalls

      public UsageRule.Builder clearAllowUnregisteredCalls()
       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:
      This builder for chaining.

    • 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;
      Specified by:
      getSkipServiceControl in interface UsageRuleOrBuilder
      Returns:
      The skipServiceControl.

    • setSkipServiceControl

      public UsageRule.Builder setSkipServiceControl(boolean value)
       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;
      Parameters:
      value - The skipServiceControl to set.
      Returns:
      This builder for chaining.

    • clearSkipServiceControl

      public UsageRule.Builder clearSkipServiceControl()
       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:
      This builder for chaining.

    • setUnknownFields

      public final UsageRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>

    • mergeUnknownFields

      public final UsageRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UsageRule.Builder>