target.apidocs.com.google.api.services.serviceconsumermanagement.v1.model.SystemParameters.html Maven / Gradle / Ivy
SystemParameters (Service Consumer Management API v1-rev20210525-1.31.0)
com.google.api.services.serviceconsumermanagement.v1.model
Class SystemParameters
- 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.SystemParameters
-
public final class SystemParameters
extends GenericJson
### System parameter configuration A system parameter is a special kind of parameter defined by
the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL
query parameter. This configuration specifies which methods change the names of the system
parameters.
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>
-
Constructor Summary
Constructors
Constructor and Description
SystemParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
SystemParameters
clone()
List<SystemParameterRule>
getRules()
Define system parameters.
SystemParameters
set(String fieldName,
Object value)
SystemParameters
setRules(List<SystemParameterRule> rules)
Define system parameters.
-
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
-
-
Method Detail
-
getRules
public List<SystemParameterRule> getRules()
Define system parameters. The parameters defined here will override the default parameters
implemented by the system. If this field is missing from the service config, default system
parameters will be used. Default system parameters and names is implementation-dependent.
Example: define api key for all methods system_parameters rules: - selector: "*" parameters: -
name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific
method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key
http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration
rules follow "last one wins" order.
- Returns:
- value or
null
for none
-
setRules
public SystemParameters setRules(List<SystemParameterRule> rules)
Define system parameters. The parameters defined here will override the default parameters
implemented by the system. If this field is missing from the service config, default system
parameters will be used. Default system parameters and names is implementation-dependent.
Example: define api key for all methods system_parameters rules: - selector: "*" parameters: -
name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific
method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key
http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration
rules follow "last one wins" order.
- Parameters:
rules
- rules or null
for none
-
set
public SystemParameters set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public SystemParameters clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2021 Google. All rights reserved.