Class: Google::Apis::NotebooksV2::OperationMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/notebooks_v2/classes.rb,
lib/google/apis/notebooks_v2/representations.rb,
lib/google/apis/notebooks_v2/representations.rb

Overview

Represents the metadata of the long-running operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OperationMetadata

Returns a new instance of OperationMetadata.



390
391
392
# File 'lib/google/apis/notebooks_v2/classes.rb', line 390

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

Instance Attribute Details

#api_versionString

API version used to start the operation. Corresponds to the JSON property apiVersion

Returns:

  • (String)


350
351
352
# File 'lib/google/apis/notebooks_v2/classes.rb', line 350

def api_version
  @api_version
end

#create_timeString

The time the operation was created. Corresponds to the JSON property createTime

Returns:

  • (String)


355
356
357
# File 'lib/google/apis/notebooks_v2/classes.rb', line 355

def create_time
  @create_time
end

#end_timeString

The time the operation finished running. Corresponds to the JSON property endTime

Returns:

  • (String)


360
361
362
# File 'lib/google/apis/notebooks_v2/classes.rb', line 360

def end_time
  @end_time
end

#endpointString

API endpoint name of this operation. Corresponds to the JSON property endpoint

Returns:

  • (String)


365
366
367
# File 'lib/google/apis/notebooks_v2/classes.rb', line 365

def endpoint
  @endpoint
end

#requested_cancellationBoolean Also known as: requested_cancellation?

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. Corresponds to the JSON property requestedCancellation

Returns:

  • (Boolean)


372
373
374
# File 'lib/google/apis/notebooks_v2/classes.rb', line 372

def requested_cancellation
  @requested_cancellation
end

#status_messageString

Human-readable status of the operation, if any. Corresponds to the JSON property statusMessage

Returns:

  • (String)


378
379
380
# File 'lib/google/apis/notebooks_v2/classes.rb', line 378

def status_message
  @status_message
end

#targetString

Server-defined resource path for the target of the operation. Corresponds to the JSON property target

Returns:

  • (String)


383
384
385
# File 'lib/google/apis/notebooks_v2/classes.rb', line 383

def target
  @target
end

#verbString

Name of the verb executed by the operation. Corresponds to the JSON property verb

Returns:

  • (String)


388
389
390
# File 'lib/google/apis/notebooks_v2/classes.rb', line 388

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



395
396
397
398
399
400
401
402
403
404
# File 'lib/google/apis/notebooks_v2/classes.rb', line 395

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation)
  @status_message = args[:status_message] if args.key?(:status_message)
  @target = args[:target] if args.key?(:target)
  @verb = args[:verb] if args.key?(:verb)
end