Class: Google::Cloud::Batch::V1::JobStatus

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/batch/v1/job.rb

Overview

Job status.

Defined Under Namespace

Modules: State Classes: InstanceStatus, TaskGroupStatus, TaskGroupsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#run_duration ⇒ ::Google::Protobuf::Duration

Returns The duration of time that the Job spent in status RUNNING.

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 126

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

  # VM instance status.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     The Compute Engine machine type.
  # @!attribute [rw] provisioning_model
  #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::ProvisioningModel]
  #     The VM instance provisioning model.
  # @!attribute [rw] task_pack
  #   @return [::Integer]
  #     The max number of tasks can be assigned to this instance type.
  class InstanceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Aggregated task status for a TaskGroup.
  # @!attribute [rw] counts
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     Count of task in each state in the TaskGroup.
  #     The map key is task state name.
  # @!attribute [rw] instances
  #   @return [::Array<::Google::Cloud::Batch::V1::JobStatus::InstanceStatus>]
  #     Status of instances allocated for the TaskGroup.
  class TaskGroupStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class CountsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Batch::V1::JobStatus::TaskGroupStatus]
  class TaskGroupsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid Job states.
  module State
    STATE_UNSPECIFIED = 0

    # Job is admitted (validated and persisted) and waiting for resources.
    QUEUED = 1

    # Job is scheduled to run as soon as resource allocation is ready.
    # The resource allocation may happen at a later time but with a high
    # chance to succeed.
    SCHEDULED = 2

    # Resource allocation has been successful. At least one Task in the Job is
    # RUNNING.
    RUNNING = 3

    # All Tasks in the Job have finished successfully.
    SUCCEEDED = 4

    # At least one Task in the Job has failed.
    FAILED = 5

    # The Job will be deleted, but has not been deleted yet. Typically this is
    # because resources used by the Job are still being cleaned up.
    DELETION_IN_PROGRESS = 6
  end
end

#state ⇒ ::Google::Cloud::Batch::V1::JobStatus::State

Returns Job state.

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 126

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

  # VM instance status.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     The Compute Engine machine type.
  # @!attribute [rw] provisioning_model
  #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::ProvisioningModel]
  #     The VM instance provisioning model.
  # @!attribute [rw] task_pack
  #   @return [::Integer]
  #     The max number of tasks can be assigned to this instance type.
  class InstanceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Aggregated task status for a TaskGroup.
  # @!attribute [rw] counts
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     Count of task in each state in the TaskGroup.
  #     The map key is task state name.
  # @!attribute [rw] instances
  #   @return [::Array<::Google::Cloud::Batch::V1::JobStatus::InstanceStatus>]
  #     Status of instances allocated for the TaskGroup.
  class TaskGroupStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class CountsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Batch::V1::JobStatus::TaskGroupStatus]
  class TaskGroupsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid Job states.
  module State
    STATE_UNSPECIFIED = 0

    # Job is admitted (validated and persisted) and waiting for resources.
    QUEUED = 1

    # Job is scheduled to run as soon as resource allocation is ready.
    # The resource allocation may happen at a later time but with a high
    # chance to succeed.
    SCHEDULED = 2

    # Resource allocation has been successful. At least one Task in the Job is
    # RUNNING.
    RUNNING = 3

    # All Tasks in the Job have finished successfully.
    SUCCEEDED = 4

    # At least one Task in the Job has failed.
    FAILED = 5

    # The Job will be deleted, but has not been deleted yet. Typically this is
    # because resources used by the Job are still being cleaned up.
    DELETION_IN_PROGRESS = 6
  end
end

#status_events ⇒ ::Array<::Google::Cloud::Batch::V1::StatusEvent>

Returns Job status events.

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 126

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

  # VM instance status.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     The Compute Engine machine type.
  # @!attribute [rw] provisioning_model
  #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::ProvisioningModel]
  #     The VM instance provisioning model.
  # @!attribute [rw] task_pack
  #   @return [::Integer]
  #     The max number of tasks can be assigned to this instance type.
  class InstanceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Aggregated task status for a TaskGroup.
  # @!attribute [rw] counts
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     Count of task in each state in the TaskGroup.
  #     The map key is task state name.
  # @!attribute [rw] instances
  #   @return [::Array<::Google::Cloud::Batch::V1::JobStatus::InstanceStatus>]
  #     Status of instances allocated for the TaskGroup.
  class TaskGroupStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class CountsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Batch::V1::JobStatus::TaskGroupStatus]
  class TaskGroupsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid Job states.
  module State
    STATE_UNSPECIFIED = 0

    # Job is admitted (validated and persisted) and waiting for resources.
    QUEUED = 1

    # Job is scheduled to run as soon as resource allocation is ready.
    # The resource allocation may happen at a later time but with a high
    # chance to succeed.
    SCHEDULED = 2

    # Resource allocation has been successful. At least one Task in the Job is
    # RUNNING.
    RUNNING = 3

    # All Tasks in the Job have finished successfully.
    SUCCEEDED = 4

    # At least one Task in the Job has failed.
    FAILED = 5

    # The Job will be deleted, but has not been deleted yet. Typically this is
    # because resources used by the Job are still being cleaned up.
    DELETION_IN_PROGRESS = 6
  end
end

#task_groups ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Batch::V1::JobStatus::TaskGroupStatus}

Returns Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 126

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

  # VM instance status.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     The Compute Engine machine type.
  # @!attribute [rw] provisioning_model
  #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::ProvisioningModel]
  #     The VM instance provisioning model.
  # @!attribute [rw] task_pack
  #   @return [::Integer]
  #     The max number of tasks can be assigned to this instance type.
  class InstanceStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Aggregated task status for a TaskGroup.
  # @!attribute [rw] counts
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     Count of task in each state in the TaskGroup.
  #     The map key is task state name.
  # @!attribute [rw] instances
  #   @return [::Array<::Google::Cloud::Batch::V1::JobStatus::InstanceStatus>]
  #     Status of instances allocated for the TaskGroup.
  class TaskGroupStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class CountsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Batch::V1::JobStatus::TaskGroupStatus]
  class TaskGroupsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid Job states.
  module State
    STATE_UNSPECIFIED = 0

    # Job is admitted (validated and persisted) and waiting for resources.
    QUEUED = 1

    # Job is scheduled to run as soon as resource allocation is ready.
    # The resource allocation may happen at a later time but with a high
    # chance to succeed.
    SCHEDULED = 2

    # Resource allocation has been successful. At least one Task in the Job is
    # RUNNING.
    RUNNING = 3

    # All Tasks in the Job have finished successfully.
    SUCCEEDED = 4

    # At least one Task in the Job has failed.
    FAILED = 5

    # The Job will be deleted, but has not been deleted yet. Typically this is
    # because resources used by the Job are still being cleaned up.
    DELETION_IN_PROGRESS = 6
  end
end