Class: Google::Cloud::Talent::V4beta1::BatchOperationMetadata
- Inherits:
-
Object
- Object
- Google::Cloud::Talent::V4beta1::BatchOperationMetadata
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/talent/v4beta1/common.rb
Overview
Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.
Defined Under Namespace
Modules: State
Instance Attribute Summary collapse
-
#create_time ⇒ ::Google::Protobuf::Timestamp
The time when the batch operation is created.
-
#end_time ⇒ ::Google::Protobuf::Timestamp
The time when the batch operation is finished and google.longrunning.Operation.done is set to
true
. -
#failure_count ⇒ ::Integer
Count of failed item(s) inside an operation.
-
#state ⇒ ::Google::Cloud::Talent::V4beta1::BatchOperationMetadata::State
The state of a long running operation.
-
#state_description ⇒ ::String
More detailed information about operation state.
-
#success_count ⇒ ::Integer
Count of successful item(s) inside an operation.
-
#total_count ⇒ ::Integer
Count of total item(s) inside an operation.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
The time when the batch operation status is updated.
Instance Attribute Details
#create_time ⇒ ::Google::Protobuf::Timestamp
Returns The time when the batch operation is created.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#end_time ⇒ ::Google::Protobuf::Timestamp
Returns The time when the batch operation is finished and
google.longrunning.Operation.done is set to true
.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#failure_count ⇒ ::Integer
Returns Count of failed item(s) inside an operation.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#state ⇒ ::Google::Cloud::Talent::V4beta1::BatchOperationMetadata::State
Returns The state of a long running operation.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#state_description ⇒ ::String
Returns More detailed information about operation state.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#success_count ⇒ ::Integer
Returns Count of successful item(s) inside an operation.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#total_count ⇒ ::Integer
Returns Count of total item(s) inside an operation.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |
#update_time ⇒ ::Google::Protobuf::Timestamp
The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'proto_docs/google/cloud/talent/v4beta1/common.rb', line 473 class BatchOperationMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module State # Default value. STATE_UNSPECIFIED = 0 # The batch operation is being prepared for processing. INITIALIZING = 1 # The batch operation is actively being processed. PROCESSING = 2 # The batch operation is processed, and at least one item has been # successfully processed. SUCCEEDED = 3 # The batch operation is done and no item has been successfully processed. FAILED = 4 # The batch operation is in the process of cancelling after # google.longrunning.Operations.CancelOperation is called. CANCELLING = 5 # The batch operation is done after # google.longrunning.Operations.CancelOperation is called. Any items # processed before cancelling are returned in the response. CANCELLED = 6 end end |