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

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



951
952
953
# File 'generated/google/apis/notebooks_v1/classes.rb', line 951

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)


911
912
913
# File 'generated/google/apis/notebooks_v1/classes.rb', line 911

def api_version
  @api_version
end

#create_timeString

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

Returns:

  • (String)


916
917
918
# File 'generated/google/apis/notebooks_v1/classes.rb', line 916

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


921
922
923
# File 'generated/google/apis/notebooks_v1/classes.rb', line 921

def end_time
  @end_time
end

#endpointString

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

Returns:

  • (String)


926
927
928
# File 'generated/google/apis/notebooks_v1/classes.rb', line 926

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)


933
934
935
# File 'generated/google/apis/notebooks_v1/classes.rb', line 933

def requested_cancellation
  @requested_cancellation
end

#status_messageString

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

Returns:

  • (String)


939
940
941
# File 'generated/google/apis/notebooks_v1/classes.rb', line 939

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)


944
945
946
# File 'generated/google/apis/notebooks_v1/classes.rb', line 944

def target
  @target
end

#verbString

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

Returns:

  • (String)


949
950
951
# File 'generated/google/apis/notebooks_v1/classes.rb', line 949

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



956
957
958
959
960
961
962
963
964
965
# File 'generated/google/apis/notebooks_v1/classes.rb', line 956

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