Class: Google::Apis::ApigeeregistryV1::OperationMetadata

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



1246
1247
1248
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1246

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)


1211
1212
1213
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1211

def api_version
  @api_version
end

#cancellation_requestedBoolean Also known as: cancellation_requested?

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 cancellationRequested

Returns:

  • (Boolean)


1218
1219
1220
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1218

def cancellation_requested
  @cancellation_requested
end

#create_timeString

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

Returns:

  • (String)


1224
1225
1226
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1224

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


1229
1230
1231
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1229

def end_time
  @end_time
end

#status_messageString

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

Returns:

  • (String)


1234
1235
1236
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1234

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)


1239
1240
1241
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1239

def target
  @target
end

#verbString

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

Returns:

  • (String)


1244
1245
1246
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1244

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1251
1252
1253
1254
1255
1256
1257
1258
1259
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 1251

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @cancellation_requested = args[:cancellation_requested] if args.key?(:cancellation_requested)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @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