Class: Google::Cloud::Dialogflow::CX::V3::Deployment

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

Overview

Represents a deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.

Defined Under Namespace

Modules: State Classes: Result

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns End time of this deployment.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb', line 51

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

  # Result of the deployment.
  # @!attribute [rw] deployment_test_results
  #   @return [::Array<::String>]
  #     Results of test cases running before the deployment.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
  # @!attribute [rw] experiment
  #   @return [::String]
  #     The name of the experiment triggered by this deployment.
  #     Format:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the deployment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The deployment is running.
    RUNNING = 1

    # The deployment succeeded.
    SUCCEEDED = 2

    # The deployment failed.
    FAILED = 3
  end
end

#flow_version ⇒ ::String

Returns The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.

Returns:

  • (::String) —

    The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb', line 51

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

  # Result of the deployment.
  # @!attribute [rw] deployment_test_results
  #   @return [::Array<::String>]
  #     Results of test cases running before the deployment.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
  # @!attribute [rw] experiment
  #   @return [::String]
  #     The name of the experiment triggered by this deployment.
  #     Format:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the deployment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The deployment is running.
    RUNNING = 1

    # The deployment succeeded.
    SUCCEEDED = 2

    # The deployment failed.
    FAILED = 3
  end
end

#name ⇒ ::String

Returns The name of the deployment. Format: projects//locations//agents//environments//deployments/.

Returns:

  • (::String) —

    The name of the deployment. Format: projects//locations//agents//environments//deployments/.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb', line 51

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

  # Result of the deployment.
  # @!attribute [rw] deployment_test_results
  #   @return [::Array<::String>]
  #     Results of test cases running before the deployment.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
  # @!attribute [rw] experiment
  #   @return [::String]
  #     The name of the experiment triggered by this deployment.
  #     Format:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the deployment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The deployment is running.
    RUNNING = 1

    # The deployment succeeded.
    SUCCEEDED = 2

    # The deployment failed.
    FAILED = 3
  end
end

#result ⇒ ::Google::Cloud::Dialogflow::CX::V3::Deployment::Result

Returns Result of the deployment.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb', line 51

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

  # Result of the deployment.
  # @!attribute [rw] deployment_test_results
  #   @return [::Array<::String>]
  #     Results of test cases running before the deployment.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
  # @!attribute [rw] experiment
  #   @return [::String]
  #     The name of the experiment triggered by this deployment.
  #     Format:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the deployment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The deployment is running.
    RUNNING = 1

    # The deployment succeeded.
    SUCCEEDED = 2

    # The deployment failed.
    FAILED = 3
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns Start time of this deployment.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb', line 51

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

  # Result of the deployment.
  # @!attribute [rw] deployment_test_results
  #   @return [::Array<::String>]
  #     Results of test cases running before the deployment.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
  # @!attribute [rw] experiment
  #   @return [::String]
  #     The name of the experiment triggered by this deployment.
  #     Format:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the deployment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The deployment is running.
    RUNNING = 1

    # The deployment succeeded.
    SUCCEEDED = 2

    # The deployment failed.
    FAILED = 3
  end
end

#state ⇒ ::Google::Cloud::Dialogflow::CX::V3::Deployment::State

Returns The current state of the deployment.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb', line 51

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

  # Result of the deployment.
  # @!attribute [rw] deployment_test_results
  #   @return [::Array<::String>]
  #     Results of test cases running before the deployment.
  #     Format:
  #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
  # @!attribute [rw] experiment
  #   @return [::String]
  #     The name of the experiment triggered by this deployment.
  #     Format:
  #     projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the deployment.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The deployment is running.
    RUNNING = 1

    # The deployment succeeded.
    SUCCEEDED = 2

    # The deployment failed.
    FAILED = 3
  end
end