target.apidocs.com.google.api.services.serviceconsumermanagement.v1.model.UsageRule.html Maven / Gradle / Ivy







UsageRule (Service Consumer Management API v1-rev20210525-1.31.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.serviceconsumermanagement.v1.model
Class UsageRule



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.serviceconsumermanagement.v1.model.UsageRule













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class UsageRule
extends GenericJson
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

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Service Consumer Management API. For a detailed
 explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


UsageRule() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


UsageRule
clone() 


Boolean
getAllowUnregisteredCalls()
If true, the selected method allows unregistered calls, e.g.



String
getSelector()
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.



UsageRule
set(String fieldName,
   Object value) 


UsageRule
setAllowUnregisteredCalls(Boolean allowUnregisteredCalls)
If true, the selected method allows unregistered calls, e.g.



UsageRule
setSelector(String selector)
Selects the methods to which this rule applies.



UsageRule
setSkipServiceControl(Boolean skipServiceControl)
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 class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





UsageRule
public UsageRule()









Method Detail





getAllowUnregisteredCalls
public Boolean getAllowUnregisteredCalls()
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user
 or application.

Returns:
value or null for none








setAllowUnregisteredCalls
public UsageRule setAllowUnregisteredCalls(Boolean allowUnregisteredCalls)
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user
 or application.

Parameters:
allowUnregisteredCalls - allowUnregisteredCalls or null for none








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.

Returns:
value or null for none








setSelector
public UsageRule setSelector(String selector)
Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
 Refer to selector for syntax details.

Parameters:
selector - selector or null for none








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.

Returns:
value or null for none








setSkipServiceControl
public UsageRule setSkipServiceControl(Boolean skipServiceControl)
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.

Parameters:
skipServiceControl - skipServiceControl or null for none








set
public UsageRule set(String fieldName,
                     Object value)

Overrides:
set in class GenericJson








clone
public UsageRule clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2021 Google. All rights reserved.

Modifier and Type	Method and Description
`UsageRule`	`clone()`
`Boolean`	`getAllowUnregisteredCalls()` If true, the selected method allows unregistered calls, e.g.
`String`	`getSelector()` 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.
`UsageRule`	`set(String fieldName, Object value)`
`UsageRule`	`setAllowUnregisteredCalls(Boolean allowUnregisteredCalls)` If true, the selected method allows unregistered calls, e.g.
`UsageRule`	`setSelector(String selector)` Selects the methods to which this rule applies.
`UsageRule`	`setSkipServiceControl(Boolean skipServiceControl)` If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available.