Class: Google::Apis::FileV1::OperationMetadata

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



1284
1285
1286
# File 'lib/google/apis/file_v1/classes.rb', line 1284

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

Instance Attribute Details

#api_versionString

[Output only] API version used to start the operation. Corresponds to the JSON property apiVersion

Returns:

  • (String)


1248
1249
1250
# File 'lib/google/apis/file_v1/classes.rb', line 1248

def api_version
  @api_version
end

#cancel_requestedBoolean Also known as: cancel_requested?

[Output only] 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 cancelRequested

Returns:

  • (Boolean)


1256
1257
1258
# File 'lib/google/apis/file_v1/classes.rb', line 1256

def cancel_requested
  @cancel_requested
end

#create_timeString

[Output only] The time the operation was created. Corresponds to the JSON property createTime

Returns:

  • (String)


1262
1263
1264
# File 'lib/google/apis/file_v1/classes.rb', line 1262

def create_time
  @create_time
end

#end_timeString

[Output only] The time the operation finished running. Corresponds to the JSON property endTime

Returns:

  • (String)


1267
1268
1269
# File 'lib/google/apis/file_v1/classes.rb', line 1267

def end_time
  @end_time
end

#status_detailString

[Output only] Human-readable status of the operation, if any. Corresponds to the JSON property statusDetail

Returns:

  • (String)


1272
1273
1274
# File 'lib/google/apis/file_v1/classes.rb', line 1272

def status_detail
  @status_detail
end

#targetString

[Output only] Server-defined resource path for the target of the operation. Corresponds to the JSON property target

Returns:

  • (String)


1277
1278
1279
# File 'lib/google/apis/file_v1/classes.rb', line 1277

def target
  @target
end

#verbString

[Output only] Name of the verb executed by the operation. Corresponds to the JSON property verb

Returns:

  • (String)


1282
1283
1284
# File 'lib/google/apis/file_v1/classes.rb', line 1282

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'lib/google/apis/file_v1/classes.rb', line 1289

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