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.



2900
2901
2902
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2900

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) 


2870
2871
2872
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2870

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) 


2875
2876
2877
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2875

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:



2881
2882
2883
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2881

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) 


2886
2887
2888
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2886

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


2891
2892
2893
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2891

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) 


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

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 2905

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