Class BuiltInUserInputAction.Builder (0.2.0)

public static final class BuiltInUserInputAction.Builder extends GeneratedMessageV3.Builder<BuiltInUserInputAction.Builder> implements BuiltInUserInputActionOrBuilder

Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the triggeraction method.

Protobuf type google.shopping.merchant.issueresolution.v1beta.BuiltInUserInputAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllFlows(Iterable<? extends ActionFlow> values)

public BuiltInUserInputAction.Builder addAllFlows(Iterable<? extends ActionFlow> values)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
values Iterable<? extends com.google.shopping.merchant.issueresolution.v1beta.ActionFlow>
Returns
Type Description
BuiltInUserInputAction.Builder

addFlows(ActionFlow value)

public BuiltInUserInputAction.Builder addFlows(ActionFlow value)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
value ActionFlow
Returns
Type Description
BuiltInUserInputAction.Builder

addFlows(ActionFlow.Builder builderForValue)

public BuiltInUserInputAction.Builder addFlows(ActionFlow.Builder builderForValue)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
builderForValue ActionFlow.Builder
Returns
Type Description
BuiltInUserInputAction.Builder

addFlows(int index, ActionFlow value)

public BuiltInUserInputAction.Builder addFlows(int index, ActionFlow value)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameters
Name Description
index int
value ActionFlow
Returns
Type Description
BuiltInUserInputAction.Builder

addFlows(int index, ActionFlow.Builder builderForValue)

public BuiltInUserInputAction.Builder addFlows(int index, ActionFlow.Builder builderForValue)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameters
Name Description
index int
builderForValue ActionFlow.Builder
Returns
Type Description
BuiltInUserInputAction.Builder

addFlowsBuilder()

public ActionFlow.Builder addFlowsBuilder()

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Returns
Type Description
ActionFlow.Builder

addFlowsBuilder(int index)

public ActionFlow.Builder addFlowsBuilder(int index)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionFlow.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BuiltInUserInputAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

build()

public BuiltInUserInputAction build()
Returns
Type Description
BuiltInUserInputAction

buildPartial()

public BuiltInUserInputAction buildPartial()
Returns
Type Description
BuiltInUserInputAction

clear()

public BuiltInUserInputAction.Builder clear()
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

clearActionContext()

public BuiltInUserInputAction.Builder clearActionContext()

Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the triggeraction method. The content should be treated as opaque and must not be modified.

string action_context = 1;

Returns
Type Description
BuiltInUserInputAction.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BuiltInUserInputAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

clearFlows()

public BuiltInUserInputAction.Builder clearFlows()

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Returns
Type Description
BuiltInUserInputAction.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BuiltInUserInputAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

clone()

public BuiltInUserInputAction.Builder clone()
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

getActionContext()

public String getActionContext()

Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the triggeraction method. The content should be treated as opaque and must not be modified.

string action_context = 1;

Returns
Type Description
String

The actionContext.

getActionContextBytes()

public ByteString getActionContextBytes()

Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the triggeraction method. The content should be treated as opaque and must not be modified.

string action_context = 1;

Returns
Type Description
ByteString

The bytes for actionContext.

getDefaultInstanceForType()

public BuiltInUserInputAction getDefaultInstanceForType()
Returns
Type Description
BuiltInUserInputAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFlows(int index)

public ActionFlow getFlows(int index)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionFlow

getFlowsBuilder(int index)

public ActionFlow.Builder getFlowsBuilder(int index)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionFlow.Builder

getFlowsBuilderList()

public List<ActionFlow.Builder> getFlowsBuilderList()

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Returns
Type Description
List<Builder>

getFlowsCount()

public int getFlowsCount()

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Returns
Type Description
int

getFlowsList()

public List<ActionFlow> getFlowsList()

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Returns
Type Description
List<ActionFlow>

getFlowsOrBuilder(int index)

public ActionFlowOrBuilder getFlowsOrBuilder(int index)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionFlowOrBuilder

getFlowsOrBuilderList()

public List<? extends ActionFlowOrBuilder> getFlowsOrBuilderList()

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Returns
Type Description
List<? extends com.google.shopping.merchant.issueresolution.v1beta.ActionFlowOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BuiltInUserInputAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BuiltInUserInputAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

mergeFrom(BuiltInUserInputAction other)

public BuiltInUserInputAction.Builder mergeFrom(BuiltInUserInputAction other)
Parameter
Name Description
other BuiltInUserInputAction
Returns
Type Description
BuiltInUserInputAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BuiltInUserInputAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

removeFlows(int index)

public BuiltInUserInputAction.Builder removeFlows(int index)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameter
Name Description
index int
Returns
Type Description
BuiltInUserInputAction.Builder

setActionContext(String value)

public BuiltInUserInputAction.Builder setActionContext(String value)

Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the triggeraction method. The content should be treated as opaque and must not be modified.

string action_context = 1;

Parameter
Name Description
value String

The actionContext to set.

Returns
Type Description
BuiltInUserInputAction.Builder

This builder for chaining.

setActionContextBytes(ByteString value)

public BuiltInUserInputAction.Builder setActionContextBytes(ByteString value)

Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the triggeraction method. The content should be treated as opaque and must not be modified.

string action_context = 1;

Parameter
Name Description
value ByteString

The bytes for actionContext to set.

Returns
Type Description
BuiltInUserInputAction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BuiltInUserInputAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

setFlows(int index, ActionFlow value)

public BuiltInUserInputAction.Builder setFlows(int index, ActionFlow value)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameters
Name Description
index int
value ActionFlow
Returns
Type Description
BuiltInUserInputAction.Builder

setFlows(int index, ActionFlow.Builder builderForValue)

public BuiltInUserInputAction.Builder setFlows(int index, ActionFlow.Builder builderForValue)

Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.

repeated .google.shopping.merchant.issueresolution.v1beta.ActionFlow flows = 3;

Parameters
Name Description
index int
builderForValue ActionFlow.Builder
Returns
Type Description
BuiltInUserInputAction.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BuiltInUserInputAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BuiltInUserInputAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides