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.



3866
3867
3868
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3866

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) 


3836
3837
3838
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3836

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) 


3841
3842
3843
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3841

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:



3847
3848
3849
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3847

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) 


3852
3853
3854
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3852

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


3857
3858
3859
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3857

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 error logs in Cloud Logging. Corresponds to the JSON property logsUrl

Returns:

  • (String) 


3864
3865
3866
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3864

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3871
3872
3873
3874
3875
3876
3877
3878
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3871

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