Class: Google::Apis::NotebooksV1::OperationMetadata

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OperationMetadata

Returns a new instance of OperationMetadata.



1726
1727
1728
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1726

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)


1686
1687
1688
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1686

def api_version
  @api_version
end

#create_timeString

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

Returns:

  • (String)


1691
1692
1693
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1691

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


1696
1697
1698
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1696

def end_time
  @end_time
end

#endpointString

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

Returns:

  • (String)


1701
1702
1703
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1701

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)


1708
1709
1710
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1708

def requested_cancellation
  @requested_cancellation
end

#status_messageString

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

Returns:

  • (String)


1714
1715
1716
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1714

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)


1719
1720
1721
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1719

def target
  @target
end

#verbString

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

Returns:

  • (String)


1724
1725
1726
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1724

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1731

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