Class BuiltInUserInputAction (0.2.0)

public final class BuiltInUserInputAction extends GeneratedMessageV3 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 Fields

ACTION_CONTEXT_FIELD_NUMBER

public static final int ACTION_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

FLOWS_FIELD_NUMBER

public static final int FLOWS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BuiltInUserInputAction getDefaultInstance()
Returns
Type Description
BuiltInUserInputAction

getDescriptor()

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

newBuilder()

public static BuiltInUserInputAction.Builder newBuilder()
Returns
Type Description
BuiltInUserInputAction.Builder

newBuilder(BuiltInUserInputAction prototype)

public static BuiltInUserInputAction.Builder newBuilder(BuiltInUserInputAction prototype)
Parameter
Name Description
prototype BuiltInUserInputAction
Returns
Type Description
BuiltInUserInputAction.Builder

parseDelimitedFrom(InputStream input)

public static BuiltInUserInputAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BuiltInUserInputAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BuiltInUserInputAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BuiltInUserInputAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BuiltInUserInputAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BuiltInUserInputAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BuiltInUserInputAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BuiltInUserInputAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BuiltInUserInputAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BuiltInUserInputAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BuiltInUserInputAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BuiltInUserInputAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuiltInUserInputAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BuiltInUserInputAction> parser()
Returns
Type Description
Parser<BuiltInUserInputAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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

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>

getParserForType()

public Parser<BuiltInUserInputAction> getParserForType()
Returns
Type Description
Parser<BuiltInUserInputAction>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BuiltInUserInputAction.Builder newBuilderForType()
Returns
Type Description
BuiltInUserInputAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BuiltInUserInputAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BuiltInUserInputAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BuiltInUserInputAction.Builder toBuilder()
Returns
Type Description
BuiltInUserInputAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException