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.



3958
3959
3960
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3958

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) 


3928
3929
3930
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3928

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) 


3933
3934
3935
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3933

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:



3939
3940
3941
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3939

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) 


3944
3945
3946
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3944

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


3949
3950
3951
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3949

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) 


3956
3957
3958
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3956

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3963
3964
3965
3966
3967
3968
3969
3970
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3963

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