Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment

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

Returns a new instance of GoogleCloudDialogflowCxV3Environment.



838
839
840
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 838

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) 


812
813
814
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 812

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) 


818
819
820
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 818

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) 


824
825
826
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 824

def name
  @name
end

#update_time ⇒ String

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

Returns:

  • (String) 


829
830
831
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 829

def update_time
  @update_time
end

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

Required. 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:



836
837
838
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 836

def version_configs
  @version_configs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



843
844
845
846
847
848
849
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 843

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)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version_configs = args[:version_configs] if args.key?(:version_configs)
end