Class: Google::Cloud::Dialogflow::V2::Environment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/environment.rb

Overview

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.

For more information, see the versions and environments guide.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#agent_version ⇒ ::String

Returns Optional. The agent version loaded into this environment. Supported formats:

  • projects/<Project ID>/agent/versions/<Version ID>
  • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>.

Returns:

  • (::String) —

    Optional. The agent version loaded into this environment. Supported formats:

    • projects/<Project ID>/agent/versions/<Version ID>
    • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end

#description ⇒ ::String

Returns Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.

Returns:

  • (::String) —

    Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end

#fulfillment ⇒ ::Google::Cloud::Dialogflow::V2::Fulfillment

Returns Optional. The fulfillment settings to use for this environment.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The unique identifier of this agent environment. Supported formats:

  • projects/<Project ID>/agent/environments/<Environment ID>
  • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>

The environment ID for the default environment is -.

Returns:

  • (::String) —

    Output only. The unique identifier of this agent environment. Supported formats:

    • projects/<Project ID>/agent/environments/<Environment ID>
    • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>

    The environment ID for the default environment is -.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end

#state ⇒ ::Google::Cloud::Dialogflow::V2::Environment::State (readonly)

Returns Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end

#text_to_speech_settings ⇒ ::Google::Cloud::Dialogflow::V2::TextToSpeechSettings

Returns Optional. Text to speech settings for this environment.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dialogflow/v2/environment.rb', line 78

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an environment state. When an environment is pointed to a new
  # agent version, the environment is temporarily set to the `LOADING` state.
  # During that time, the environment keeps on serving the previous version of
  # the agent. After the new agent version is done loading, the environment is
  # set back to the `RUNNING` state.
  module State
    # Not specified. This value is not used.
    STATE_UNSPECIFIED = 0

    # Stopped.
    STOPPED = 1

    # Loading.
    LOADING = 2

    # Running.
    RUNNING = 3
  end
end