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.



3729
3730
3731
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3729

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

Instance Attribute Details

#api_method_nameString

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

Returns:

  • (String)


3699
3700
3701
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3699

def api_method_name
  @api_method_name
end

#cancel_requestedBoolean Also known as: cancel_requested?

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

Returns:

  • (Boolean)


3704
3705
3706
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3704

def cancel_requested
  @cancel_requested
end

#counterGoogle::Apis::HealthcareV1::ProgressCounter

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



3710
3711
3712
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3710

def counter
  @counter
end

#create_timeString

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

Returns:

  • (String)


3715
3716
3717
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3715

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


3720
3721
3722
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3720

def end_time
  @end_time
end

#logs_urlString

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)


3727
3728
3729
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3727

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3734
3735
3736
3737
3738
3739
3740
3741
# File 'lib/google/apis/healthcare_v1/classes.rb', line 3734

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