target.apidocs.com.google.api.services.content.model.InputField.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation

There is a newer version: v2.1-rev20240825-2.0.0

Show newest version







InputField (Content API for Shopping v2.1-rev20240609-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.content.model
Class InputField



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.InputField













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




public final class InputField
extends com.google.api.client.json.GenericJson
Input field that needs to be available to the merchant. If the field is marked as required, then
 a value needs to be provided for a successful processing of the request.

  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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


InputField() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


InputField
clone() 


InputFieldCheckboxInput
getCheckboxInput()
Input field to provide a boolean value.



InputFieldChoiceInput
getChoiceInput()
Input field to select one of the offered choices.



String
getId()
Not for display but need to be sent back for the given input field.



TextWithTooltip
getLabel()
Input field label.



Boolean
getRequired()
Whether the field is required.



InputFieldTextInput
getTextInput()
Input field to provide text information.



InputField
set(String fieldName,
   Object value) 


InputField
setCheckboxInput(InputFieldCheckboxInput checkboxInput)
Input field to provide a boolean value.



InputField
setChoiceInput(InputFieldChoiceInput choiceInput)
Input field to select one of the offered choices.



InputField
setId(String id)
Not for display but need to be sent back for the given input field.



InputField
setLabel(TextWithTooltip label)
Input field label.



InputField
setRequired(Boolean required)
Whether the field is required.



InputField
setTextInput(InputFieldTextInput textInput)
Input field to provide text information.







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





InputField
public InputField()









Method Detail





getCheckboxInput
public InputFieldCheckboxInput getCheckboxInput()
Input field to provide a boolean value. Corresponds to the [html input
 type=checkbox](https://www.w3.org/TR/2012/WD-html-
 markup-20121025/input.checkbox.html#input.checkbox).

Returns:
value or null for none








setCheckboxInput
public InputField setCheckboxInput(InputFieldCheckboxInput checkboxInput)
Input field to provide a boolean value. Corresponds to the [html input
 type=checkbox](https://www.w3.org/TR/2012/WD-html-
 markup-20121025/input.checkbox.html#input.checkbox).

Parameters:
checkboxInput - checkboxInput or null for none








getChoiceInput
public InputFieldChoiceInput getChoiceInput()
Input field to select one of the offered choices. Corresponds to the [html input
 type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio).

Returns:
value or null for none








setChoiceInput
public InputField setChoiceInput(InputFieldChoiceInput choiceInput)
Input field to select one of the offered choices. Corresponds to the [html input
 type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio).

Parameters:
choiceInput - choiceInput or null for none








getId
public String getId()
Not for display but need to be sent back for the given input field.

Returns:
value or null for none








setId
public InputField setId(String id)
Not for display but need to be sent back for the given input field.

Parameters:
id - id or null for none








getLabel
public TextWithTooltip getLabel()
Input field label. There may be more information to be shown in a tooltip.

Returns:
value or null for none








setLabel
public InputField setLabel(TextWithTooltip label)
Input field label. There may be more information to be shown in a tooltip.

Parameters:
label - label or null for none








getRequired
public Boolean getRequired()
Whether the field is required. The action button needs to stay disabled till values for all
 required fields are provided.

Returns:
value or null for none








setRequired
public InputField setRequired(Boolean required)
Whether the field is required. The action button needs to stay disabled till values for all
 required fields are provided.

Parameters:
required - required or null for none








getTextInput
public InputFieldTextInput getTextInput()
Input field to provide text information. Corresponds to the [html input
 type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or
 [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).

Returns:
value or null for none








setTextInput
public InputField setTextInput(InputFieldTextInput textInput)
Input field to provide text information. Corresponds to the [html input
 type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or
 [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).

Parameters:
textInput - textInput or null for none








set
public InputField set(String fieldName,
                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public InputField clone()

Overrides:
clone in class com.google.api.client.json.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–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`InputField`	`clone()`
`InputFieldCheckboxInput`	`getCheckboxInput()` Input field to provide a boolean value.
`InputFieldChoiceInput`	`getChoiceInput()` Input field to select one of the offered choices.
`String`	`getId()` Not for display but need to be sent back for the given input field.
`TextWithTooltip`	`getLabel()` Input field label.
`Boolean`	`getRequired()` Whether the field is required.
`InputFieldTextInput`	`getTextInput()` Input field to provide text information.
`InputField`	`set(String fieldName, Object value)`
`InputField`	`setCheckboxInput(InputFieldCheckboxInput checkboxInput)` Input field to provide a boolean value.
`InputField`	`setChoiceInput(InputFieldChoiceInput choiceInput)` Input field to select one of the offered choices.
`InputField`	`setId(String id)` Not for display but need to be sent back for the given input field.
`InputField`	`setLabel(TextWithTooltip label)` Input field label.
`InputField`	`setRequired(Boolean required)` Whether the field is required.
`InputField`	`setTextInput(InputFieldTextInput textInput)` Input field to provide text information.