Skip to content

Commit

Permalink
docs: Refine usage scope for fields task_execution and task_state
Browse files Browse the repository at this point in the history
… in StatusEvent (#26607)
  • Loading branch information
gcf-owl-bot[bot] authored Aug 6, 2024
1 parent be60b59 commit 0daf958
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions google-cloud-batch-v1/proto_docs/google/cloud/batch/v1/task.rb
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class ComputeResource
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# Status event
# Status event.
# @!attribute [rw] type
# @return [::String]
# Type of the event.
Expand All @@ -86,10 +86,13 @@ class ComputeResource
# The time this event occurred.
# @!attribute [rw] task_execution
# @return [::Google::Cloud::Batch::V1::TaskExecution]
# Task Execution
# Task Execution.
# This field is only defined for task-level status events where the task
# fails.
# @!attribute [rw] task_state
# @return [::Google::Cloud::Batch::V1::TaskStatus::State]
# Task State
# Task State.
# This field is only defined for task-level status events.
class StatusEvent
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand All @@ -115,10 +118,10 @@ class TaskExecution
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# Status of a task
# Status of a task.
# @!attribute [rw] state
# @return [::Google::Cloud::Batch::V1::TaskStatus::State]
# Task state
# Task state.
# @!attribute [rw] status_events
# @return [::Array<::Google::Cloud::Batch::V1::StatusEvent>]
# Detailed info about why the state is reached.
Expand Down

0 comments on commit 0daf958

Please sign in to comment.