Class AutomatedAgentConfig (4.48.0)

public final class AutomatedAgentConfig extends GeneratedMessageV3 implements AutomatedAgentConfigOrBuilder

Defines the Automated Agent to connect to a conversation.

Protobuf type google.cloud.dialogflow.v2.AutomatedAgentConfig

Static Fields

AGENT_FIELD_NUMBER

public static final int AGENT_FIELD_NUMBER
Field Value
Type Description
int

SESSION_TTL_FIELD_NUMBER

public static final int SESSION_TTL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutomatedAgentConfig getDefaultInstance()
Returns
Type Description
AutomatedAgentConfig

getDescriptor()

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

newBuilder()

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

newBuilder(AutomatedAgentConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

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.

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 AutomatedAgentConfig.Builder newBuilderForType()
Returns
Type Description
AutomatedAgentConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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