Class: Google::Apis::ToolresultsV1beta3::SuggestionProto

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SuggestionProto

Returns a new instance of SuggestionProto.



3087
3088
3089
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3087

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

Instance Attribute Details

#help_url ⇒ String

Reference to a help center article concerning this type of suggestion. Always set. Corresponds to the JSON property helpUrl

Returns:

  • (String) 


3021
3022
3023
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3021

def help_url
  @help_url
end

#long_message ⇒ Google::Apis::ToolresultsV1beta3::SafeHtmlProto

IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests. Corresponds to the JSON property longMessage

Returns:



3031
3032
3033
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3031

def long_message
  @long_message
end

#priority ⇒ String

Relative importance of a suggestion. Always set. Corresponds to the JSON property priority

Returns:

  • (String) 


3036
3037
3038
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3036

def priority
  @priority
end

#pseudo_resource_id ⇒ String

A somewhat human readable identifier of the source view, if it does not have a resource_name. This is a path within the accessibility hierarchy, an element with resource name; similar to an XPath. Corresponds to the JSON property pseudoResourceId

Returns:

  • (String) 


3043
3044
3045
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3043

def pseudo_resource_id
  @pseudo_resource_id
end

#region ⇒ Google::Apis::ToolresultsV1beta3::RegionProto

A rectangular region. Corresponds to the JSON property region

Returns:



3048
3049
3050
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3048

def region
  @region
end

#resource_name ⇒ String

Reference to a view element, identified by its resource name, if it has one. Corresponds to the JSON property resourceName

Returns:

  • (String) 


3053
3054
3055
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3053

def resource_name
  @resource_name
end

#screen_id ⇒ String

ID of the screen for the suggestion. It is used for getting the corresponding screenshot path. For example, screen_id "1" corresponds to "1.png" file in GCS. Always set. Corresponds to the JSON property screenId

Returns:

  • (String) 


3060
3061
3062
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3060

def screen_id
  @screen_id
end

#secondary_priority ⇒ Float

Relative importance of a suggestion as compared with other suggestions that have the same priority and category. This is a meaningless value that can be used to order suggestions that are in the same category and have the same priority. The larger values have higher priority (i.e., are more important). Optional. Corresponds to the JSON property secondaryPriority

Returns:

  • (Float) 


3069
3070
3071
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3069

def secondary_priority
  @secondary_priority
end

#short_message ⇒ Google::Apis::ToolresultsV1beta3::SafeHtmlProto

IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests. Corresponds to the JSON property shortMessage

Returns:



3079
3080
3081
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3079

def short_message
  @short_message
end

#title ⇒ String

General title for the suggestion, in the user's language, without markup. Always set. Corresponds to the JSON property title

Returns:

  • (String) 


3085
3086
3087
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3085

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
 
# File 'generated/google/apis/toolresults_v1beta3/classes.rb', line 3092

def update!(**args)
  @help_url = args[:help_url] if args.key?(:help_url)
  @long_message = args[:long_message] if args.key?(:long_message)
  @priority = args[:priority] if args.key?(:priority)
  @pseudo_resource_id = args[:pseudo_resource_id] if args.key?(:pseudo_resource_id)
  @region = args[:region] if args.key?(:region)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @screen_id = args[:screen_id] if args.key?(:screen_id)
  @secondary_priority = args[:secondary_priority] if args.key?(:secondary_priority)
  @short_message = args[:short_message] if args.key?(:short_message)
  @title = args[:title] if args.key?(:title)
end