Class: Google::Longrunning::Operation

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#done ⇒ true, false

Returns 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.

Returns:

  • (true, false) —

    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.



48
 
# File 'lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb', line 48

class Operation; end

#error ⇒ Google::Rpc::Status

Returns The error result of the operation in case of failure or cancellation.

Returns:

  • (Google::Rpc::Status) —

    The error result of the operation in case of failure or cancellation.



48
 
# File 'lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb', line 48

class Operation; end

#metadata ⇒ Google::Protobuf::Any

Returns 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.

Returns:

  • (Google::Protobuf::Any) —

    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.



48
 
# File 'lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb', line 48

class Operation; end

#name ⇒ String

Returns 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 have the format of +operations/some/unique/name+.

Returns:

  • (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 have the format of +operations/some/unique/name+.



48
 
# File 'lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb', line 48

class Operation; end

#response ⇒ Google::Protobuf::Any

Returns 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+.

Returns:

  • (Google::Protobuf::Any) —

    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+.



48
 
# File 'lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb', line 48

class Operation; end