Class: Google::Apis::HealthcareV1::OperationMetadata

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

Overview

OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OperationMetadata

Returns a new instance of OperationMetadata.



2897
2898
2899
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2897

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

Instance Attribute Details

#api_method_name ⇒ String

The name of the API method that initiated the operation. Corresponds to the JSON property apiMethodName

Returns:

  • (String) 


2867
2868
2869
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2867

def api_method_name
  @api_method_name
end

#cancel_requested ⇒ Boolean Also known as: cancel_requested?

Specifies if cancellation was requested for the operation. Corresponds to the JSON property cancelRequested

Returns:

  • (Boolean) 


2872
2873
2874
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2872

def cancel_requested
  @cancel_requested
end

#counter ⇒ Google::Apis::HealthcareV1::ProgressCounter

ProgressCounter provides counters to describe an operation's progress. Corresponds to the JSON property counter

Returns:



2878
2879
2880
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2878

def counter
  @counter
end

#create_time ⇒ String

The time at which the operation was created by the API. Corresponds to the JSON property createTime

Returns:

  • (String) 


2883
2884
2885
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2883

def create_time
  @create_time
end

#end_time ⇒ String

The time at which execution was completed. Corresponds to the JSON property endTime

Returns:

  • (String) 


2888
2889
2890
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2888

def end_time
  @end_time
end

#logs_url ⇒ String

A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at Viewing logs. Corresponds to the JSON property logsUrl

Returns:

  • (String) 


2895
2896
2897
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2895

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2902
2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2902

def update!(**args)
  @api_method_name = args[:api_method_name] if args.key?(:api_method_name)
  @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested)
  @counter = args[:counter] if args.key?(:counter)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @logs_url = args[:logs_url] if args.key?(:logs_url)
end