Class: Google::Apis::HealthcareV1beta1::OperationMetadata

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



5268
5269
5270
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5268

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) 


5235
5236
5237
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5235

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) 


5240
5241
5242
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5240

def cancel_requested
  @cancel_requested
end

#counter ⇒ Google::Apis::HealthcareV1beta1::ProgressCounter

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

Returns:



5246
5247
5248
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5246

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) 


5251
5252
5253
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5251

def create_time
  @create_time
end

#end_time ⇒ String

The time at which execution workloads were completed. Some tasks will complete after this time such as logging audit logs. Corresponds to the JSON property endTime

Returns:

  • (String) 


5257
5258
5259
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5257

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. The end_time specified in this URL may not match the end time on the metadata because logs are written asynchronously from execution. Corresponds to the JSON property logsUrl

Returns:

  • (String) 


5266
5267
5268
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5266

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5273
5274
5275
5276
5277
5278
5279
5280
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 5273

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