Class: Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

Overview

The common metadata for long running operations.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The creation time of the operation.

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 313

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end

#state ⇒ ::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata::State

Returns The state of the operation.

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 313

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end

#state_message ⇒ ::String

Returns A message providing more details about the current state of processing.

Returns:

  • (::String) —

    A message providing more details about the current state of processing.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 313

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns The last update time of the operation.

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 313

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end