target.apidocs.com.google.api.services.serviceconsumermanagement.v1.model.CustomError.html Maven / Gradle / Ivy
CustomError (Service Consumer Management API v1-rev20210525-1.31.0)
com.google.api.services.serviceconsumermanagement.v1.model
Class CustomError
- 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.CustomError
-
public final class CustomError
extends GenericJson
Customize service error responses. For example, list any service specific protobuf types that can
appear in error detail lists of error responses. Example: custom_error: types: -
google.foo.v1.CustomError - google.foo.v1.AnotherError
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
CustomError()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
CustomError
clone()
List<CustomErrorRule>
getRules()
The list of custom error rules that apply to individual API messages.
List<String>
getTypes()
The list of custom error detail types, e.g.
CustomError
set(String fieldName,
Object value)
CustomError
setRules(List<CustomErrorRule> rules)
The list of custom error rules that apply to individual API messages.
CustomError
setTypes(List<String> types)
The list of custom error detail types, e.g.
-
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<CustomErrorRule> getRules()
The list of custom error rules that apply to individual API messages. **NOTE:** All service
configuration rules follow "last one wins" order.
- Returns:
- value or
null
for none
-
setRules
public CustomError setRules(List<CustomErrorRule> rules)
The list of custom error rules that apply to individual API messages. **NOTE:** All service
configuration rules follow "last one wins" order.
- Parameters:
rules
- rules or null
for none
-
getTypes
public List<String> getTypes()
The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- Returns:
- value or
null
for none
-
setTypes
public CustomError setTypes(List<String> types)
The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- Parameters:
types
- types or null
for none
-
set
public CustomError set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public CustomError clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2021 Google. All rights reserved.