target.apidocs.com.google.api.services.toolresults.model.SuggestionProto.html Maven / Gradle / Ivy

Go to download







SuggestionProto (Cloud Tool Results API v1beta3-rev20210809-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.toolresults.model
Class SuggestionProto



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.toolresults.model.SuggestionProto













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class SuggestionProto
extends GenericJson
Model definition for SuggestionProto.

  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 Cloud Tool Results 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


SuggestionProto() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SuggestionProto
clone() 


String
getHelpUrl()
Reference to a help center article concerning this type of suggestion.



SafeHtmlProto
getLongMessage()
Message, in the user's language, explaining the suggestion, which may contain markup.



String
getPriority()
Relative importance of a suggestion.



String
getPseudoResourceId()
A somewhat human readable identifier of the source view, if it does not have a resource_name.



RegionProto
getRegion()
Region within the screenshot that is relevant to this suggestion.



String
getResourceName()
Reference to a view element, identified by its resource name, if it has one.



String
getScreenId()
ID of the screen for the suggestion.



Double
getSecondaryPriority()
Relative importance of a suggestion as compared with other suggestions that have the same
 priority and category.



SafeHtmlProto
getShortMessage()
Concise message, in the user's language, representing the suggestion, which may contain markup.



String
getTitle()
General title for the suggestion, in the user's language, without markup.



SuggestionProto
set(String fieldName,
   Object value) 


SuggestionProto
setHelpUrl(String helpUrl)
Reference to a help center article concerning this type of suggestion.



SuggestionProto
setLongMessage(SafeHtmlProto longMessage)
Message, in the user's language, explaining the suggestion, which may contain markup.



SuggestionProto
setPriority(String priority)
Relative importance of a suggestion.



SuggestionProto
setPseudoResourceId(String pseudoResourceId)
A somewhat human readable identifier of the source view, if it does not have a resource_name.



SuggestionProto
setRegion(RegionProto region)
Region within the screenshot that is relevant to this suggestion.



SuggestionProto
setResourceName(String resourceName)
Reference to a view element, identified by its resource name, if it has one.



SuggestionProto
setScreenId(String screenId)
ID of the screen for the suggestion.



SuggestionProto
setSecondaryPriority(Double secondaryPriority)
Relative importance of a suggestion as compared with other suggestions that have the same
 priority and category.



SuggestionProto
setShortMessage(SafeHtmlProto shortMessage)
Concise message, in the user's language, representing the suggestion, which may contain markup.



SuggestionProto
setTitle(String title)
General title for the suggestion, in the user's language, without markup.







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





SuggestionProto
public SuggestionProto()









Method Detail





getHelpUrl
public String getHelpUrl()
Reference to a help center article concerning this type of suggestion. Always set.

Returns:
value or null for none








setHelpUrl
public SuggestionProto setHelpUrl(String helpUrl)
Reference to a help center article concerning this type of suggestion. Always set.

Parameters:
helpUrl - helpUrl or null for none








getLongMessage
public SafeHtmlProto getLongMessage()
Message, in the user's language, explaining the suggestion, which may contain markup. Always
 set.

Returns:
value or null for none








setLongMessage
public SuggestionProto setLongMessage(SafeHtmlProto longMessage)
Message, in the user's language, explaining the suggestion, which may contain markup. Always
 set.

Parameters:
longMessage - longMessage or null for none








getPriority
public String getPriority()
Relative importance of a suggestion. Always set.

Returns:
value or null for none








setPriority
public SuggestionProto setPriority(String priority)
Relative importance of a suggestion. Always set.

Parameters:
priority - priority or null for none








getPseudoResourceId
public String getPseudoResourceId()
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.

Returns:
value or null for none








setPseudoResourceId
public SuggestionProto setPseudoResourceId(String pseudoResourceId)
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.

Parameters:
pseudoResourceId - pseudoResourceId or null for none








getRegion
public RegionProto getRegion()
Region within the screenshot that is relevant to this suggestion. Optional.

Returns:
value or null for none








setRegion
public SuggestionProto setRegion(RegionProto region)
Region within the screenshot that is relevant to this suggestion. Optional.

Parameters:
region - region or null for none








getResourceName
public String getResourceName()
Reference to a view element, identified by its resource name, if it has one.

Returns:
value or null for none








setResourceName
public SuggestionProto setResourceName(String resourceName)
Reference to a view element, identified by its resource name, if it has one.

Parameters:
resourceName - resourceName or null for none








getScreenId
public String getScreenId()
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.

Returns:
value or null for none








setScreenId
public SuggestionProto setScreenId(String screenId)
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.

Parameters:
screenId - screenId or null for none








getSecondaryPriority
public Double getSecondaryPriority()
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.

Returns:
value or null for none








setSecondaryPriority
public SuggestionProto setSecondaryPriority(Double secondaryPriority)
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.

Parameters:
secondaryPriority - secondaryPriority or null for none








getShortMessage
public SafeHtmlProto getShortMessage()
Concise message, in the user's language, representing the suggestion, which may contain markup.
 Always set.

Returns:
value or null for none








setShortMessage
public SuggestionProto setShortMessage(SafeHtmlProto shortMessage)
Concise message, in the user's language, representing the suggestion, which may contain markup.
 Always set.

Parameters:
shortMessage - shortMessage or null for none








getTitle
public String getTitle()
General title for the suggestion, in the user's language, without markup. Always set.

Returns:
value or null for none








setTitle
public SuggestionProto setTitle(String title)
General title for the suggestion, in the user's language, without markup. Always set.

Parameters:
title - title or null for none








set
public SuggestionProto set(String fieldName,
                           Object value)

Overrides:
set in class GenericJson








clone
public SuggestionProto clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`SuggestionProto`	`clone()`
`String`	`getHelpUrl()` Reference to a help center article concerning this type of suggestion.
`SafeHtmlProto`	`getLongMessage()` Message, in the user's language, explaining the suggestion, which may contain markup.
`String`	`getPriority()` Relative importance of a suggestion.
`String`	`getPseudoResourceId()` A somewhat human readable identifier of the source view, if it does not have a resource_name.
`RegionProto`	`getRegion()` Region within the screenshot that is relevant to this suggestion.
`String`	`getResourceName()` Reference to a view element, identified by its resource name, if it has one.
`String`	`getScreenId()` ID of the screen for the suggestion.
`Double`	`getSecondaryPriority()` Relative importance of a suggestion as compared with other suggestions that have the same priority and category.
`SafeHtmlProto`	`getShortMessage()` Concise message, in the user's language, representing the suggestion, which may contain markup.
`String`	`getTitle()` General title for the suggestion, in the user's language, without markup.
`SuggestionProto`	`set(String fieldName, Object value)`
`SuggestionProto`	`setHelpUrl(String helpUrl)` Reference to a help center article concerning this type of suggestion.
`SuggestionProto`	`setLongMessage(SafeHtmlProto longMessage)` Message, in the user's language, explaining the suggestion, which may contain markup.
`SuggestionProto`	`setPriority(String priority)` Relative importance of a suggestion.
`SuggestionProto`	`setPseudoResourceId(String pseudoResourceId)` A somewhat human readable identifier of the source view, if it does not have a resource_name.
`SuggestionProto`	`setRegion(RegionProto region)` Region within the screenshot that is relevant to this suggestion.
`SuggestionProto`	`setResourceName(String resourceName)` Reference to a view element, identified by its resource name, if it has one.
`SuggestionProto`	`setScreenId(String screenId)` ID of the screen for the suggestion.
`SuggestionProto`	`setSecondaryPriority(Double secondaryPriority)` Relative importance of a suggestion as compared with other suggestions that have the same priority and category.
`SuggestionProto`	`setShortMessage(SafeHtmlProto shortMessage)` Concise message, in the user's language, representing the suggestion, which may contain markup.
`SuggestionProto`	`setTitle(String title)` General title for the suggestion, in the user's language, without markup.