com.google.api.services.toolresults.model.SuggestionProto Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.toolresults.model;
/**
* 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.
*/
@SuppressWarnings("javadoc")
public final class SuggestionProto extends com.google.api.client.json.GenericJson {
/**
* Reference to a help center article concerning this type of suggestion. Always set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String helpUrl;
/**
* Message, in the user's language, explaining the suggestion, which may contain markup. Always
* set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private SafeHtmlProto longMessage;
/**
* Relative importance of a suggestion. Always set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String priority;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String pseudoResourceId;
/**
* Region within the screenshot that is relevant to this suggestion. Optional.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private RegionProto region;
/**
* Reference to a view element, identified by its resource name, if it has one.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String resourceName;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String screenId;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Double secondaryPriority;
/**
* Concise message, in the user's language, representing the suggestion, which may contain markup.
* Always set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private SafeHtmlProto shortMessage;
/**
* General title for the suggestion, in the user's language, without markup. Always set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String title;
/**
* Reference to a help center article concerning this type of suggestion. Always set.
* @return value or {@code null} for none
*/
public java.lang.String getHelpUrl() {
return helpUrl;
}
/**
* Reference to a help center article concerning this type of suggestion. Always set.
* @param helpUrl helpUrl or {@code null} for none
*/
public SuggestionProto setHelpUrl(java.lang.String helpUrl) {
this.helpUrl = helpUrl;
return this;
}
/**
* Message, in the user's language, explaining the suggestion, which may contain markup. Always
* set.
* @return value or {@code null} for none
*/
public SafeHtmlProto getLongMessage() {
return longMessage;
}
/**
* Message, in the user's language, explaining the suggestion, which may contain markup. Always
* set.
* @param longMessage longMessage or {@code null} for none
*/
public SuggestionProto setLongMessage(SafeHtmlProto longMessage) {
this.longMessage = longMessage;
return this;
}
/**
* Relative importance of a suggestion. Always set.
* @return value or {@code null} for none
*/
public java.lang.String getPriority() {
return priority;
}
/**
* Relative importance of a suggestion. Always set.
* @param priority priority or {@code null} for none
*/
public SuggestionProto setPriority(java.lang.String priority) {
this.priority = priority;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getPseudoResourceId() {
return 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.
* @param pseudoResourceId pseudoResourceId or {@code null} for none
*/
public SuggestionProto setPseudoResourceId(java.lang.String pseudoResourceId) {
this.pseudoResourceId = pseudoResourceId;
return this;
}
/**
* Region within the screenshot that is relevant to this suggestion. Optional.
* @return value or {@code null} for none
*/
public RegionProto getRegion() {
return region;
}
/**
* Region within the screenshot that is relevant to this suggestion. Optional.
* @param region region or {@code null} for none
*/
public SuggestionProto setRegion(RegionProto region) {
this.region = region;
return this;
}
/**
* Reference to a view element, identified by its resource name, if it has one.
* @return value or {@code null} for none
*/
public java.lang.String getResourceName() {
return resourceName;
}
/**
* Reference to a view element, identified by its resource name, if it has one.
* @param resourceName resourceName or {@code null} for none
*/
public SuggestionProto setResourceName(java.lang.String resourceName) {
this.resourceName = resourceName;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getScreenId() {
return 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.
* @param screenId screenId or {@code null} for none
*/
public SuggestionProto setScreenId(java.lang.String screenId) {
this.screenId = screenId;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.Double getSecondaryPriority() {
return 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.
* @param secondaryPriority secondaryPriority or {@code null} for none
*/
public SuggestionProto setSecondaryPriority(java.lang.Double secondaryPriority) {
this.secondaryPriority = secondaryPriority;
return this;
}
/**
* Concise message, in the user's language, representing the suggestion, which may contain markup.
* Always set.
* @return value or {@code null} for none
*/
public SafeHtmlProto getShortMessage() {
return shortMessage;
}
/**
* Concise message, in the user's language, representing the suggestion, which may contain markup.
* Always set.
* @param shortMessage shortMessage or {@code null} for none
*/
public SuggestionProto setShortMessage(SafeHtmlProto shortMessage) {
this.shortMessage = shortMessage;
return this;
}
/**
* General title for the suggestion, in the user's language, without markup. Always set.
* @return value or {@code null} for none
*/
public java.lang.String getTitle() {
return title;
}
/**
* General title for the suggestion, in the user's language, without markup. Always set.
* @param title title or {@code null} for none
*/
public SuggestionProto setTitle(java.lang.String title) {
this.title = title;
return this;
}
@Override
public SuggestionProto set(String fieldName, Object value) {
return (SuggestionProto) super.set(fieldName, value);
}
@Override
public SuggestionProto clone() {
return (SuggestionProto) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy