Class: Google::Apis::NotebooksV1::OperationMetadata
- Inherits:
-
Object
- Object
- Google::Apis::NotebooksV1::OperationMetadata
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/notebooks_v1/classes.rb,
lib/google/apis/notebooks_v1/representations.rb,
lib/google/apis/notebooks_v1/representations.rb
Overview
Represents the metadata of the long-running operation.
Instance Attribute Summary collapse
-
#api_version ⇒ String
API version used to start the operation.
-
#create_time ⇒ String
The time the operation was created.
-
#end_time ⇒ String
The time the operation finished running.
-
#endpoint ⇒ String
API endpoint name of this operation.
-
#requested_cancellation ⇒ Boolean
(also: #requested_cancellation?)
Identifies whether the user has requested cancellation of the operation.
-
#status_message ⇒ String
Human-readable status of the operation, if any.
-
#target ⇒ String
Server-defined resource path for the target of the operation.
-
#verb ⇒ String
Name of the verb executed by the operation.
Instance Method Summary collapse
-
#initialize(**args) ⇒ OperationMetadata
constructor
A new instance of OperationMetadata.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ OperationMetadata
Returns a new instance of OperationMetadata.
1498 1499 1500 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1498 def initialize(**args) update!(**args) end |
Instance Attribute Details
#api_version ⇒ String
API version used to start the operation.
Corresponds to the JSON property apiVersion
1458 1459 1460 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1458 def api_version @api_version end |
#create_time ⇒ String
The time the operation was created.
Corresponds to the JSON property createTime
1463 1464 1465 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1463 def create_time @create_time end |
#end_time ⇒ String
The time the operation finished running.
Corresponds to the JSON property endTime
1468 1469 1470 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1468 def end_time @end_time end |
#endpoint ⇒ String
API endpoint name of this operation.
Corresponds to the JSON property endpoint
1473 1474 1475 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1473 def endpoint @endpoint end |
#requested_cancellation ⇒ Boolean 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
1480 1481 1482 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1480 def requested_cancellation @requested_cancellation end |
#status_message ⇒ String
Human-readable status of the operation, if any.
Corresponds to the JSON property statusMessage
1486 1487 1488 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1486 def @status_message end |
#target ⇒ String
Server-defined resource path for the target of the operation.
Corresponds to the JSON property target
1491 1492 1493 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1491 def target @target end |
#verb ⇒ String
Name of the verb executed by the operation.
Corresponds to the JSON property verb
1496 1497 1498 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1496 def verb @verb end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 |
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1503 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 |