Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1Environment

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

Overview

Represents an environment for an agent. 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Environment

Returns a new instance of GoogleCloudDialogflowCxV3beta1Environment.



9516
9517
9518
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9516

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

Instance Attribute Details

#description ⇒ String

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. Corresponds to the JSON property description

Returns:

  • (String) 


9480
9481
9482
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9480

def description
  @description
end

#display_name ⇒ String

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


9486
9487
9488
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9486

def display_name
  @display_name
end

#name ⇒ String

The name of the environment. Format: projects//locations//agents// environments/. Corresponds to the JSON property name

Returns:

  • (String) 


9492
9493
9494
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9492

def name
  @name
end

#test_cases_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig

The configuration for continuous tests. Corresponds to the JSON property testCasesConfig

Returns:



9497
9498
9499
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9497

def test_cases_config
  @test_cases_config
end

#update_time ⇒ String

Output only. Update time of this environment. Corresponds to the JSON property updateTime

Returns:

  • (String) 


9502
9503
9504
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9502

def update_time
  @update_time
end

#version_configs ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig>

A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned. Corresponds to the JSON property versionConfigs

Returns:



9509
9510
9511
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9509

def version_configs
  @version_configs
end

#webhook_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig

Configuration for webhooks. Corresponds to the JSON property webhookConfig

Returns:



9514
9515
9516
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9514

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9521

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @test_cases_config = args[:test_cases_config] if args.key?(:test_cases_config)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version_configs = args[:version_configs] if args.key?(:version_configs)
  @webhook_config = args[:webhook_config] if args.key?(:webhook_config)
end