Class: Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

This resource represents a long-running operation that is the result of a network API call.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleLongrunningOperation

Returns a new instance of GoogleLongrunningOperation.



9721
9722
9723
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9721

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#done ⇒ Boolean Also known as: done?

If the value is false, it means the operation is still in progress. If true , the operation is completed, and either error or response is available. Corresponds to the JSON property done

Returns:

  • (Boolean) 


9682
9683
9684
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9682

def done
  @done
end

#error ⇒ Google::Apis::DocumentaiV1beta3::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



9693
9694
9695
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9693

def error
  @error
end

#metadata ⇒ Hash<String,Object>

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


9701
9702
9703
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9701

def metadata
  @metadata
end

#name ⇒ String

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/unique_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


9708
9709
9710
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9708

def name
  @name
end

#response ⇒ Hash<String,Object>

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google. protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>) 


9719
9720
9721
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9719

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9726
9727
9728
9729
9730
9731
9732
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 9726

def update!(**args)
  @done = args[:done] if args.key?(:done)
  @error = args[:error] if args.key?(:error)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @response = args[:response] if args.key?(:response)
end