target.apidocs.com.google.api.services.content.model.ActionReason.html Maven / Gradle / Ivy
ActionReason (Content API for Shopping v2.1-rev20240609-2.0.0)
com.google.api.services.content.model
Class ActionReason
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.content.model.ActionReason
-
public final class ActionReason
extends com.google.api.client.json.GenericJson
A single reason why the action is not available.
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 Content API for Shopping. 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
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
ActionReason()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
ActionReason
clone()
Action
getAction()
Optional.
String
getDetail()
Detailed explanation of the reason.
String
getMessage()
Messages summarizing the reason, why the action is not available.
ActionReason
set(String fieldName,
Object value)
ActionReason
setAction(Action action)
Optional.
ActionReason
setDetail(String detail)
Detailed explanation of the reason.
ActionReason
setMessage(String message)
Messages summarizing the reason, why the action is not available.
-
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
-
-
Method Detail
-
getAction
public Action getAction()
Optional. An action that needs to be performed to solve the problem represented by this reason.
This action will always be available. Should be rendered as a link or button next to the
summarizing message. For example, the review may be available only once merchant configure all
required attributes. In such a situation this action can be a link to the form, where they can
fill the missing attribute to unblock the main action.
- Returns:
- value or
null
for none
-
setAction
public ActionReason setAction(Action action)
Optional. An action that needs to be performed to solve the problem represented by this reason.
This action will always be available. Should be rendered as a link or button next to the
summarizing message. For example, the review may be available only once merchant configure all
required attributes. In such a situation this action can be a link to the form, where they can
fill the missing attribute to unblock the main action.
- Parameters:
action
- action or null
for none
-
getDetail
public String getDetail()
Detailed explanation of the reason. Should be displayed as a hint if present.
- Returns:
- value or
null
for none
-
setDetail
public ActionReason setDetail(String detail)
Detailed explanation of the reason. Should be displayed as a hint if present.
- Parameters:
detail
- detail or null
for none
-
getMessage
public String getMessage()
Messages summarizing the reason, why the action is not available. For example: "Review
requested on Jan 03. Review requests can take a few days to complete."
- Returns:
- value or
null
for none
-
setMessage
public ActionReason setMessage(String message)
Messages summarizing the reason, why the action is not available. For example: "Review
requested on Jan 03. Review requests can take a few days to complete."
- Parameters:
message
- message or null
for none
-
set
public ActionReason set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public ActionReason clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy