Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1Environment

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

Returns a new instance of GoogleCloudDialogflowCxV3beta1Environment.



3562
3563
3564
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3562

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

Instance Attribute Details

#descriptionString

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)


3526
3527
3528
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3526

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


3532
3533
3534
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3532

def display_name
  @display_name
end

#nameString

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

Returns:

  • (String)


3538
3539
3540
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3538

def name
  @name
end

#test_cases_configGoogle::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig

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



3543
3544
3545
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3543

def test_cases_config
  @test_cases_config
end

#update_timeString

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

Returns:

  • (String)


3548
3549
3550
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3548

def update_time
  @update_time
end

#version_configsArray<Google::Apis::DialogflowV2::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



3555
3556
3557
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3555

def version_configs
  @version_configs
end

#webhook_configGoogle::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig

Configuration for webhooks. Corresponds to the JSON property webhookConfig



3560
3561
3562
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3560

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3567
3568
3569
3570
3571
3572
3573
3574
3575
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3567

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