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 more...

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.

[View source]

1882
1883
1884
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1882

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

Returns:

  • (String) 

1841
1842
1843
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1841

def api_version
  @api_version
end

#create_time ⇒ String

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

Returns:

  • (String) 

1846
1847
1848
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1846

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 

1851
1852
1853
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1851

def end_time
  @end_time
end

#endpoint ⇒ String

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

Returns:

  • (String) 

1856
1857
1858
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1856

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 google.longrunning. Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. Corresponds to the JSON property requestedCancellation

Returns:

  • (Boolean) 

1864
1865
1866
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1864

def requested_cancellation
  @requested_cancellation
end

#status_message ⇒ String

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

Returns:

  • (String) 

1870
1871
1872
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1870

def status_message
  @status_message
end

#target ⇒ String

Server-defined resource path for the target of the operation. Corresponds to the JSON property target

Returns:

  • (String) 

1875
1876
1877
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1875

def target
  @target
end

#verb ⇒ String

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

Returns:

  • (String) 

1880
1881
1882
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1880

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 1887

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