Class: Google::Apis::VideointelligenceV1::GoogleLongrunningOperation
- Inherits:
-
Object
- Object
- Google::Apis::VideointelligenceV1::GoogleLongrunningOperation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/videointelligence_v1/classes.rb,
generated/google/apis/videointelligence_v1/representations.rb,
generated/google/apis/videointelligence_v1/representations.rb
Overview
This resource represents a long-running operation that is the result of a network API call.
Instance Attribute Summary collapse
-
#done ⇒ Boolean
(also: #done?)
If the value is
false
, it means the operation is still in progress. -
#error ⇒ Google::Apis::VideointelligenceV1::GoogleRpcStatus
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. -
#metadata ⇒ Hash<String,Object>
Service-specific metadata associated with the operation.
-
#name ⇒ String
The server-assigned name, which is only unique within the same service that originally returns it.
-
#response ⇒ Hash<String,Object>
The normal response of the operation in case of success.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleLongrunningOperation
constructor
A new instance of GoogleLongrunningOperation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleLongrunningOperation
Returns a new instance of GoogleLongrunningOperation.
5006 5007 5008 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 5006 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
4966 4967 4968 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 4966 def done @done end |
#error ⇒ Google::Apis::VideointelligenceV1::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
4977 4978 4979 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 4977 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
4985 4986 4987 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 4985 def @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 property
name`
4992 4993 4994 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 4992 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
5004 5005 5006 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 5004 def response @response end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5011 5012 5013 5014 5015 5016 5017 |
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 5011 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 |