Class AutomatedAgentConfig.Builder (4.89.0)

public static final class AutomatedAgentConfig.Builder extends GeneratedMessage.Builder<AutomatedAgentConfig.Builder> implements AutomatedAgentConfigOrBuilder

Defines the Automated Agent to connect to a conversation.

Protobuf type google.cloud.dialogflow.v2beta1.AutomatedAgentConfig

Static Methods

getDescriptor()

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

Methods

build()

public AutomatedAgentConfig build()
Returns
Type Description
AutomatedAgentConfig

buildPartial()

public AutomatedAgentConfig buildPartial()
Returns
Type Description
AutomatedAgentConfig

clear()

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

clearAgent()

public AutomatedAgentConfig.Builder clearAgent()

Required. ID of the Dialogflow agent environment to use.

This project needs to either be the same project as the conversation or you need to grant service-<Conversation Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project.

  • For ES agents, use format: projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details.

  • For CX agents, use format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used.

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

Returns
Type Description
AutomatedAgentConfig.Builder

This builder for chaining.

clearSessionTtl()

public AutomatedAgentConfig.Builder clearSessionTtl()

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AutomatedAgentConfig.Builder

getAgent()

public String getAgent()

Required. ID of the Dialogflow agent environment to use.

This project needs to either be the same project as the conversation or you need to grant service-<Conversation Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project.

  • For ES agents, use format: projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details.

  • For CX agents, use format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used.

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

Returns
Type Description
String

The agent.

getAgentBytes()

public ByteString getAgentBytes()

Required. ID of the Dialogflow agent environment to use.

This project needs to either be the same project as the conversation or you need to grant service-<Conversation Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project.

  • For ES agents, use format: projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details.

  • For CX agents, use format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used.

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

Returns
Type Description
ByteString

The bytes for agent.

getDefaultInstanceForType()

public AutomatedAgentConfig getDefaultInstanceForType()
Returns
Type Description
AutomatedAgentConfig

getDescriptorForType()

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

getSessionTtl()

public Duration getSessionTtl()

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The sessionTtl.

getSessionTtlBuilder()

public Duration.Builder getSessionTtlBuilder()

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getSessionTtlOrBuilder()

public DurationOrBuilder getSessionTtlOrBuilder()

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

hasSessionTtl()

public boolean hasSessionTtl()

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sessionTtl field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AutomatedAgentConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSessionTtl(Duration value)

public AutomatedAgentConfig.Builder mergeSessionTtl(Duration value)

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
AutomatedAgentConfig.Builder

setAgent(String value)

public AutomatedAgentConfig.Builder setAgent(String value)

Required. ID of the Dialogflow agent environment to use.

This project needs to either be the same project as the conversation or you need to grant service-<Conversation Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project.

  • For ES agents, use format: projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details.

  • For CX agents, use format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used.

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

Parameter
Name Description
value String

The agent to set.

Returns
Type Description
AutomatedAgentConfig.Builder

This builder for chaining.

setAgentBytes(ByteString value)

public AutomatedAgentConfig.Builder setAgentBytes(ByteString value)

Required. ID of the Dialogflow agent environment to use.

This project needs to either be the same project as the conversation or you need to grant service-<Conversation Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API Service Agent role in this project.

  • For ES agents, use format: projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used. Refer to DetectIntentRequest for more details.

  • For CX agents, use format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID or '-'>. If environment is not specified, the default draft environment is used.

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

Parameter
Name Description
value ByteString

The bytes for agent to set.

Returns
Type Description
AutomatedAgentConfig.Builder

This builder for chaining.

setSessionTtl(Duration value)

public AutomatedAgentConfig.Builder setSessionTtl(Duration value)

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
AutomatedAgentConfig.Builder

setSessionTtl(Duration.Builder builderForValue)

public AutomatedAgentConfig.Builder setSessionTtl(Duration.Builder builderForValue)

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AutomatedAgentConfig.Builder