Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/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.



5468
5469
5470
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5468

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) 


5432
5433
5434
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5432

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) 


5438
5439
5440
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5438

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) 


5444
5445
5446
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5444

def name
  @name
end

#test_cases_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig

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

Returns:



5449
5450
5451
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5449

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) 


5454
5455
5456
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5454

def update_time
  @update_time
end

#version_configs ⇒ Array<Google::Apis::DialogflowV3beta1::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:



5461
5462
5463
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5461

def version_configs
  @version_configs
end

#webhook_config ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig

Configuration for webhooks. Corresponds to the JSON property webhookConfig

Returns:



5466
5467
5468
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5466

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5473
5474
5475
5476
5477
5478
5479
5480
5481
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 5473

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