Class: Google::Cloud::Workflows::Executions::V1beta::Execution

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/workflows/executions/v1beta/executions.rb

Overview

A running instance of a [Workflow][google.cloud.workflows.v1beta.Workflow].

Defined Under Namespace

Modules: State Classes: Error

Instance Attribute Summary collapse

Instance Attribute Details

#argument ⇒ ::String

Returns Input parameters of the execution represented as a JSON string. The size limit is 32KB.

Returns:

  • (::String) —

    Input parameters of the execution represented as a JSON string. The size limit is 32KB.



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

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

Returns Output only. Marks the end of execution, successful or not.

Returns:



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

#error ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution::Error (readonly)

Returns Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.

Returns:



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

Returns:

  • (::String) —

    Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

#result ⇒ ::String (readonly)

Returns Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.

Returns:

  • (::String) —

    Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

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

Returns Output only. Marks the beginning of execution.

Returns:



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

#state ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution::State (readonly)

Returns Output only. Current state of the execution.

Returns:



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end

#workflow_revision_id ⇒ ::String (readonly)

Returns Output only. Revision of the workflow this execution is using.

Returns:

  • (::String) —

    Output only. Revision of the workflow this execution is using.



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
86
87
88
89
90
 
# File 'proto_docs/google/cloud/workflows/executions/v1beta/executions.rb', line 56

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

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error payload returned by the execution, represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human readable error context, helpful for debugging purposes.
  class Error
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the execution. More states may be added
  # in the future.
  module State
    # Invalid state.
    STATE_UNSPECIFIED = 0

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # The execution failed with an error.
    FAILED = 3

    # The execution was stopped intentionally.
    CANCELLED = 4
  end
end