Class: Google::Apis::YoutubeAnalyticsV2::ErrorProto

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/youtube_analytics_v2/classes.rb,
lib/google/apis/youtube_analytics_v2/representations.rb,
lib/google/apis/youtube_analytics_v2/representations.rb

Overview

Describes one specific error.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ErrorProto

Returns a new instance of ErrorProto.



96
97
98
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 96

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#argument ⇒ Array<String>

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

Returns:

  • (Array<String>) 


53
54
55
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 53

def argument
  @argument
end

#code ⇒ String

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. Corresponds to the JSON property code

Returns:

  • (String) 


59
60
61
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 59

def code
  @code
end

#debug_info ⇒ String

Debugging information, which should not be shared externally. Corresponds to the JSON property debugInfo

Returns:

  • (String) 


64
65
66
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 64

def debug_info
  @debug_info
end

#domain ⇒ String

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 Corresponds to the JSON property domain

Returns:

  • (String) 


70
71
72
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 70

def domain
  @domain
end

#external_error_message ⇒ String

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. Corresponds to the JSON property externalErrorMessage

Returns:

  • (String) 


81
82
83
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 81

def external_error_message
  @external_error_message
end

#location ⇒ String

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 Corresponds to the JSON property location

Returns:

  • (String) 


89
90
91
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 89

def location
  @location
end

#location_type ⇒ String

Corresponds to the JSON property locationType

Returns:

  • (String) 


94
95
96
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 94

def location_type
  @location_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



101
102
103
104
105
106
107
108
109
 
# File 'lib/google/apis/youtube_analytics_v2/classes.rb', line 101

def update!(**args)
  @argument = args[:argument] if args.key?(:argument)
  @code = args[:code] if args.key?(:code)
  @debug_info = args[:debug_info] if args.key?(:debug_info)
  @domain = args[:domain] if args.key?(:domain)
  @external_error_message = args[:external_error_message] if args.key?(:external_error_message)
  @location = args[:location] if args.key?(:location)
  @location_type = args[:location_type] if args.key?(:location_type)
end