Class: Google::Cloud::Vision::V1::BatchOperationMetadata

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

Overview

Metadata for the batch operations such as the current state.

This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the batch request is finished and google.longrunning.Operation.done is set to true.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 613

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

  # Enumerates the possible states that the batch request can be in.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is actively being processed.
    PROCESSING = 1

    # The request is done and at least one item has been successfully
    # processed.
    SUCCESSFUL = 2

    # The request is done and no item has been successfully processed.
    FAILED = 3

    # The request is done after the longrunning.Operations.CancelOperation has
    # been called by the user.  Any records that were processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 4
  end
end

#state ⇒ ::Google::Cloud::Vision::V1::BatchOperationMetadata::State

Returns The current state of the batch operation.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 613

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

  # Enumerates the possible states that the batch request can be in.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is actively being processed.
    PROCESSING = 1

    # The request is done and at least one item has been successfully
    # processed.
    SUCCESSFUL = 2

    # The request is done and no item has been successfully processed.
    FAILED = 3

    # The request is done after the longrunning.Operations.CancelOperation has
    # been called by the user.  Any records that were processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 4
  end
end

#submit_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the batch request was submitted to the server.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 613

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

  # Enumerates the possible states that the batch request can be in.
  module State
    # Invalid.
    STATE_UNSPECIFIED = 0

    # Request is actively being processed.
    PROCESSING = 1

    # The request is done and at least one item has been successfully
    # processed.
    SUCCESSFUL = 2

    # The request is done and no item has been successfully processed.
    FAILED = 3

    # The request is done after the longrunning.Operations.CancelOperation has
    # been called by the user.  Any records that were processed before the
    # cancel command are output as specified in the request.
    CANCELLED = 4
  end
end