com.google.api.services.youtubeAnalytics.v2.model

Class ErrorProto

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.youtubeAnalytics.v2.model.ErrorProto

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ErrorProto
extends GenericJson

Describes one specific error.

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 YouTube Analytics 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
ErrorProto()

Method Summary

Modifier and Type	Method and Description
ErrorProto	clone()
List<String>	getArgument() Error arguments, to be used when building user-friendly error messages given the error domain and code.
String	getCode() Error code in the error domain.
String	getDebugInfo() Debugging information, which should not be shared externally.
String	getDomain() Error domain.
String	getExternalErrorMessage() A short explanation for the error, which can be shared outside Google.
String	getLocation() Location of the error, as specified by the location type.
String	getLocationType()
ErrorProto	set(String fieldName, Object value)
ErrorProto	setArgument(List<String> argument) Error arguments, to be used when building user-friendly error messages given the error domain and code.
ErrorProto	setCode(String code) Error code in the error domain.
ErrorProto	setDebugInfo(String debugInfo) Debugging information, which should not be shared externally.
ErrorProto	setDomain(String domain) Error domain.
ErrorProto	setExternalErrorMessage(String externalErrorMessage) A short explanation for the error, which can be shared outside Google.
ErrorProto	setLocation(String location) Location of the error, as specified by the location type.
ErrorProto	setLocationType(String locationType)

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

ErrorProto

public ErrorProto()

Method Detail

getArgument

public List<String> getArgument()

Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.

Returns:

value or null for none

setArgument

public ErrorProto setArgument(List<String> argument)

Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.

Parameters:

argument - argument or null for none

getCode

public String getCode()

Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.

Returns:

value or null for none

setCode

public ErrorProto setCode(String code)

Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.

Parameters:

code - code or null for none

getDebugInfo

public String getDebugInfo()

Debugging information, which should not be shared externally.

Returns:

value or null for none

setDebugInfo

public ErrorProto setDebugInfo(String debugInfo)

Debugging information, which should not be shared externally.

Parameters:

debugInfo - debugInfo or null for none

getDomain

public String getDomain()

Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain

Returns:

value or null for none

setDomain

public ErrorProto setDomain(String domain)

Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain

Parameters:

domain - domain or null for none

getExternalErrorMessage

public String getExternalErrorMessage()

A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.

Returns:

value or null for none

setExternalErrorMessage

public ErrorProto setExternalErrorMessage(String externalErrorMessage)

A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.

Parameters:

externalErrorMessage - externalErrorMessage or null for none

getLocation

public String getLocation()

Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country

Returns:

value or null for none

setLocation

public ErrorProto setLocation(String location)

Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country

Parameters:

location - location or null for none

getLocationType

public String getLocationType()

Returns:

value or null for none

setLocationType

public ErrorProto setLocationType(String locationType)

Parameters:

locationType - locationType or null for none

set

public ErrorProto set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public ErrorProto clone()

Overrides:

clone in class GenericJson