Class: Google::Apis::WebriskV1::GoogleLongrunningOperation

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



459
460
461
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 459

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) 


425
426
427
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 425

def done
  @done
end

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



436
437
438
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 436

def error
  @error
end

#metadata ⇒ Hash<String,Object>

Contains a SubmitUriMetadata object. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


441
442
443
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 441

def metadata
  @metadata
end

#name ⇒ String

Matches the /v1/project-name/operations/operation-id`pattern. Corresponds to the JSON propertyname`

Returns:

  • (String) 


446
447
448
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 446

def name
  @name
end

#response ⇒ Hash<String,Object>

The normal, successful response of the operation. 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>) 


457
458
459
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 457

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



464
465
466
467
468
469
470
 
# File 'lib/google/apis/webrisk_v1/classes.rb', line 464

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