Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/representations.rb

Overview

You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the versions and environments guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2Environment

Returns a new instance of GoogleCloudDialogflowV2Environment.



6283
6284
6285
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6283

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent_version ⇒ String

Optional. The agent version loaded into this environment. Format: projects// agent/versions/. Corresponds to the JSON property agentVersion

Returns:

  • (String) 


6256
6257
6258
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6256

def agent_version
  @agent_version
end

#description ⇒ String

Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. Corresponds to the JSON property description

Returns:

  • (String) 


6262
6263
6264
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6262

def description
  @description
end

#name ⇒ String

Output only. The unique identifier of this agent environment. Format: projects//agent/environments/. For Environment ID, "-" is reserved for 'draft' environment. Corresponds to the JSON property name

Returns:

  • (String) 


6269
6270
6271
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6269

def name
  @name
end

#state ⇒ String

Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. Corresponds to the JSON property state

Returns:

  • (String) 


6275
6276
6277
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6275

def state
  @state
end

#update_time ⇒ String

Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. Corresponds to the JSON property updateTime

Returns:

  • (String) 


6281
6282
6283
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6281

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6288
6289
6290
6291
6292
6293
6294
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6288

def update!(**args)
  @agent_version = args[:agent_version] if args.key?(:agent_version)
  @description = args[:description] if args.key?(:description)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end