Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3Environment

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

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) ⇒ GoogleCloudDialogflowCxV3Environment

Returns a new instance of GoogleCloudDialogflowCxV3Environment.



513
514
515
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 513

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) 


477
478
479
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 477

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) 


483
484
485
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 483

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) 


489
490
491
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 489

def name
  @name
end

#test_cases_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig

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

Returns:



494
495
496
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 494

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) 


499
500
501
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 499

def update_time
  @update_time
end

#version_configs ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3EnvironmentVersionConfig>

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:



506
507
508
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 506

def version_configs
  @version_configs
end

#webhook_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3EnvironmentWebhookConfig

Configuration for webhooks. Corresponds to the JSON property webhookConfig

Returns:



511
512
513
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 511

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



518
519
520
521
522
523
524
525
526
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 518

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