Class: Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow

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

Overview

A migration workflow which specifies what needs to be done for an EDW migration.

Defined Under Namespace

Modules: State Classes: TasksEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Time when the workflow was created.

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/bigquery/migration/v2/migration_entities.rb', line 51

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
  class TasksEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible migration workflow states.
  module State
    # Workflow state is unspecified.
    STATE_UNSPECIFIED = 0

    # Workflow is in draft status, i.e. tasks are not yet eligible for
    # execution.
    DRAFT = 1

    # Workflow is running (i.e. tasks are eligible for execution).
    RUNNING = 2

    # Workflow is paused. Tasks currently in progress may continue, but no
    # further tasks will be scheduled.
    PAUSED = 3

    # Workflow is complete. There should not be any task in a non-terminal
    # state, but if they are (e.g. forced termination), they will not be
    # scheduled.
    COMPLETED = 4
  end
end

#display_name ⇒ ::String

Returns The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness.

Returns:

  • (::String) —

    The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness.



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/bigquery/migration/v2/migration_entities.rb', line 51

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
  class TasksEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible migration workflow states.
  module State
    # Workflow state is unspecified.
    STATE_UNSPECIFIED = 0

    # Workflow is in draft status, i.e. tasks are not yet eligible for
    # execution.
    DRAFT = 1

    # Workflow is running (i.e. tasks are eligible for execution).
    RUNNING = 2

    # Workflow is paused. Tasks currently in progress may continue, but no
    # further tasks will be scheduled.
    PAUSED = 3

    # Workflow is complete. There should not be any task in a non-terminal
    # state, but if they are (e.g. forced termination), they will not be
    # scheduled.
    COMPLETED = 4
  end
end

#last_update_time ⇒ ::Google::Protobuf::Timestamp

Returns Time when the workflow was last updated.

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/bigquery/migration/v2/migration_entities.rb', line 51

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
  class TasksEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible migration workflow states.
  module State
    # Workflow state is unspecified.
    STATE_UNSPECIFIED = 0

    # Workflow is in draft status, i.e. tasks are not yet eligible for
    # execution.
    DRAFT = 1

    # Workflow is running (i.e. tasks are eligible for execution).
    RUNNING = 2

    # Workflow is paused. Tasks currently in progress may continue, but no
    # further tasks will be scheduled.
    PAUSED = 3

    # Workflow is complete. There should not be any task in a non-terminal
    # state, but if they are (e.g. forced termination), they will not be
    # scheduled.
    COMPLETED = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Immutable. The unique identifier for the migration workflow. The ID is server-generated.

Example: projects/123/locations/us/workflows/345.

Returns:

  • (::String) —

    Output only. Immutable. The unique identifier for the migration workflow. The ID is server-generated.

    Example: projects/123/locations/us/workflows/345



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/bigquery/migration/v2/migration_entities.rb', line 51

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
  class TasksEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible migration workflow states.
  module State
    # Workflow state is unspecified.
    STATE_UNSPECIFIED = 0

    # Workflow is in draft status, i.e. tasks are not yet eligible for
    # execution.
    DRAFT = 1

    # Workflow is running (i.e. tasks are eligible for execution).
    RUNNING = 2

    # Workflow is paused. Tasks currently in progress may continue, but no
    # further tasks will be scheduled.
    PAUSED = 3

    # Workflow is complete. There should not be any task in a non-terminal
    # state, but if they are (e.g. forced termination), they will not be
    # scheduled.
    COMPLETED = 4
  end
end

#state ⇒ ::Google::Cloud::Bigquery::Migration::V2::MigrationWorkflow::State (readonly)

Returns Output only. That status of the workflow.

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/bigquery/migration/v2/migration_entities.rb', line 51

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
  class TasksEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible migration workflow states.
  module State
    # Workflow state is unspecified.
    STATE_UNSPECIFIED = 0

    # Workflow is in draft status, i.e. tasks are not yet eligible for
    # execution.
    DRAFT = 1

    # Workflow is running (i.e. tasks are eligible for execution).
    RUNNING = 2

    # Workflow is paused. Tasks currently in progress may continue, but no
    # further tasks will be scheduled.
    PAUSED = 3

    # Workflow is complete. There should not be any task in a non-terminal
    # state, but if they are (e.g. forced termination), they will not be
    # scheduled.
    COMPLETED = 4
  end
end

#tasks ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigquery::Migration::V2::MigrationTask}

Returns The tasks in a workflow in a named map. The name (i.e. key) has no meaning and is merely a convenient way to address a specific task in a workflow.

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/bigquery/migration/v2/migration_entities.rb', line 51

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Bigquery::Migration::V2::MigrationTask]
  class TasksEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible migration workflow states.
  module State
    # Workflow state is unspecified.
    STATE_UNSPECIFIED = 0

    # Workflow is in draft status, i.e. tasks are not yet eligible for
    # execution.
    DRAFT = 1

    # Workflow is running (i.e. tasks are eligible for execution).
    RUNNING = 2

    # Workflow is paused. Tasks currently in progress may continue, but no
    # further tasks will be scheduled.
    PAUSED = 3

    # Workflow is complete. There should not be any task in a non-terminal
    # state, but if they are (e.g. forced termination), they will not be
    # scheduled.
    COMPLETED = 4
  end
end