Show / Hide Table of Contents

Class ErrorProto

Describes one specific error.

Inheritance
object
ErrorProto
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.YouTubeAnalytics.v2.Data
Assembly: Google.Apis.YouTubeAnalytics.v2.dll
Syntax
public class ErrorProto : IDirectResponseSchema

Properties

Argument

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

Declaration
[JsonProperty("argument")]
public virtual IList<string> Argument { get; set; }
Property Value
Type Description
IList<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.

Declaration
[JsonProperty("code")]
public virtual string Code { get; set; }
Property Value
Type Description
string

DebugInfo

Debugging information, which should not be shared externally.

Declaration
[JsonProperty("debugInfo")]
public virtual string DebugInfo { get; set; }
Property Value
Type Description
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

Declaration
[JsonProperty("domain")]
public virtual string Domain { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("externalErrorMessage")]
public virtual string ExternalErrorMessage { get; set; }
Property Value
Type Description
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

Declaration
[JsonProperty("location")]
public virtual string Location { get; set; }
Property Value
Type Description
string

LocationType

Declaration
[JsonProperty("locationType")]
public virtual string LocationType { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX