Class: Google::Cloud::Talent::V4::BatchOperationMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/talent/v4/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

Instance Attribute Details

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

Returns The time when the batch operation is created.

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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.

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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.

Returns:

  • (::Integer) —

    Count of failed item(s) inside an operation.



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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::V4::BatchOperationMetadata::State

Returns The state of a long running operation.

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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.

Returns:

  • (::String) —

    More detailed information about operation state.



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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.

Returns:

  • (::Integer) —

    Count of successful item(s) inside an operation.



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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.

Returns:

  • (::Integer) —

    Count of total item(s) inside an operation.



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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

Returns The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 527

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