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
more...

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.

[View source]

4484
4485
4486
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4484

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)

4454
4455
4456
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4454

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)

4459
4460
4461
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4459

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


4465
4466
4467
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4465

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)

4470
4471
4472
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4470

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)

4475
4476
4477
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4475

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)

4482
4483
4484
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4482

def logs_url
  @logs_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

4489
4490
4491
4492
4493
4494
4495
4496
# File 'lib/google/apis/healthcare_v1/classes.rb', line 4489

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