Class PlaybookInvocation.Builder (0.55.0)

public static final class PlaybookInvocation.Builder extends GeneratedMessageV3.Builder<PlaybookInvocation.Builder> implements PlaybookInvocationOrBuilder

Stores metadata of the invocation of a child playbook. Next Id: 5

Protobuf type google.cloud.dialogflow.cx.v3beta1.PlaybookInvocation

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PlaybookInvocation build()
Returns
Type Description
PlaybookInvocation

buildPartial()

public PlaybookInvocation buildPartial()
Returns
Type Description
PlaybookInvocation

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPlaybook()

public PlaybookInvocation.Builder clearPlaybook()

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string playbook = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
PlaybookInvocation.Builder

This builder for chaining.

clearPlaybookInput()

public PlaybookInvocation.Builder clearPlaybookInput()

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInvocation.Builder

clearPlaybookOutput()

public PlaybookInvocation.Builder clearPlaybookOutput()

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInvocation.Builder

clearPlaybookState()

public PlaybookInvocation.Builder clearPlaybookState()

Required. Playbook invocation's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PlaybookInvocation.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public PlaybookInvocation getDefaultInstanceForType()
Returns
Type Description
PlaybookInvocation

getDescriptorForType()

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

getPlaybook()

public String getPlaybook()

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string playbook = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The playbook.

getPlaybookBytes()

public ByteString getPlaybookBytes()

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string playbook = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for playbook.

getPlaybookInput()

public PlaybookInput getPlaybookInput()

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInput

The playbookInput.

getPlaybookInputBuilder()

public PlaybookInput.Builder getPlaybookInputBuilder()

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInput.Builder

getPlaybookInputOrBuilder()

public PlaybookInputOrBuilder getPlaybookInputOrBuilder()

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInputOrBuilder

getPlaybookOutput()

public PlaybookOutput getPlaybookOutput()

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookOutput

The playbookOutput.

getPlaybookOutputBuilder()

public PlaybookOutput.Builder getPlaybookOutputBuilder()

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookOutput.Builder

getPlaybookOutputOrBuilder()

public PlaybookOutputOrBuilder getPlaybookOutputOrBuilder()

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookOutputOrBuilder

getPlaybookState()

public OutputState getPlaybookState()

Required. Playbook invocation's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputState

The playbookState.

getPlaybookStateValue()

public int getPlaybookStateValue()

Required. Playbook invocation's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for playbookState.

hasPlaybookInput()

public boolean hasPlaybookInput()

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the playbookInput field is set.

hasPlaybookOutput()

public boolean hasPlaybookOutput()

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the playbookOutput field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PlaybookInvocation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePlaybookInput(PlaybookInput value)

public PlaybookInvocation.Builder mergePlaybookInput(PlaybookInput value)

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookInput
Returns
Type Description
PlaybookInvocation.Builder

mergePlaybookOutput(PlaybookOutput value)

public PlaybookInvocation.Builder mergePlaybookOutput(PlaybookOutput value)

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookOutput
Returns
Type Description
PlaybookInvocation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPlaybook(String value)

public PlaybookInvocation.Builder setPlaybook(String value)

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string playbook = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The playbook to set.

Returns
Type Description
PlaybookInvocation.Builder

This builder for chaining.

setPlaybookBytes(ByteString value)

public PlaybookInvocation.Builder setPlaybookBytes(ByteString value)

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string playbook = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for playbook to set.

Returns
Type Description
PlaybookInvocation.Builder

This builder for chaining.

setPlaybookInput(PlaybookInput value)

public PlaybookInvocation.Builder setPlaybookInput(PlaybookInput value)

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookInput
Returns
Type Description
PlaybookInvocation.Builder

setPlaybookInput(PlaybookInput.Builder builderForValue)

public PlaybookInvocation.Builder setPlaybookInput(PlaybookInput.Builder builderForValue)

Optional. Input of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PlaybookInput.Builder
Returns
Type Description
PlaybookInvocation.Builder

setPlaybookOutput(PlaybookOutput value)

public PlaybookInvocation.Builder setPlaybookOutput(PlaybookOutput value)

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookOutput
Returns
Type Description
PlaybookInvocation.Builder

setPlaybookOutput(PlaybookOutput.Builder builderForValue)

public PlaybookInvocation.Builder setPlaybookOutput(PlaybookOutput.Builder builderForValue)

Optional. Output of the child playbook invocation.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PlaybookOutput.Builder
Returns
Type Description
PlaybookInvocation.Builder

setPlaybookState(OutputState value)

public PlaybookInvocation.Builder setPlaybookState(OutputState value)

Required. Playbook invocation's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value OutputState

The playbookState to set.

Returns
Type Description
PlaybookInvocation.Builder

This builder for chaining.

setPlaybookStateValue(int value)

public PlaybookInvocation.Builder setPlaybookStateValue(int value)

Required. Playbook invocation's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for playbookState to set.

Returns
Type Description
PlaybookInvocation.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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