Class: Google::Apis::ApigeeV1::GoogleLongrunningOperation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/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.



7800
7801
7802
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7800

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) 


7761
7762
7763
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7761

def done
  @done
end

#error ⇒ Google::Apis::ApigeeV1::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:



7772
7773
7774
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7772

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>) 


7780
7781
7782
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7780

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) 


7787
7788
7789
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7787

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>) 


7798
7799
7800
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7798

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7805

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