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.



4567
4568
4569
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4567

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)


4531
4532
4533
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4531

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)


4537
4538
4539
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4537

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)


4543
4544
4545
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4543

def name
  @name
end

#test_cases_configGoogle::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig

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



4548
4549
4550
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4548

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)


4553
4554
4555
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4553

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



4560
4561
4562
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4560

def version_configs
  @version_configs
end

#webhook_configGoogle::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig

Configuration for webhooks. Corresponds to the JSON property webhookConfig



4565
4566
4567
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4565

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4572
4573
4574
4575
4576
4577
4578
4579
4580
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4572

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