Class: Google::Apis::StorageV1::GoogleLongrunningOperation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/storage_v1/classes.rb,
lib/google/apis/storage_v1/representations.rb,
lib/google/apis/storage_v1/representations.rb

Overview

This resource represents a long-running operation that is the result of a network API call.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleLongrunningOperation

Returns a new instance of GoogleLongrunningOperation.



1906
1907
1908
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1906

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#done ⇒ Boolean Also known as: done?

If the value is "false", it means the operation is still in progress. If "true" , the operation is completed, and either "error" or "response" is available. Corresponds to the JSON property done

Returns:

  • (Boolean) 


1857
1858
1859
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1857

def done
  @done
end

#error ⇒ Google::Apis::StorageV1::GoogleRpcStatus

The "Status" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each "Status" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



1868
1869
1870
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1868

def error
  @error
end

#kind ⇒ String

The kind of item this is. For operations, this is always storage#operation. Corresponds to the JSON property kind

Returns:

  • (String) 


1873
1874
1875
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1873

def kind
  @kind
end

#metadata ⇒ Hash<String,Object>

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. Corresponds to the JSON property metadata

Returns:



1881
1882
1883
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1881

def metadata
  @metadata
end

#name ⇒ String

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the "name" should be a resource name ending with "operations/operationId". Corresponds to the JSON property name

Returns:

  • (String) 


1888
1889
1890
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1888

def name
  @name
end

#response ⇒ Hash<String,Object>

The normal response of the operation in case of success. If the original method returns no data on success, such as "Delete", the response is google. protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type "XxxResponse", where "Xxx" is the original method name. For example, if the original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse". Corresponds to the JSON property response

Returns:



1899
1900
1901
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1899

def response
  @response
end

#self_link ⇒ String

The link to this long running operation. Corresponds to the JSON property selfLink

Returns:

  • (String) 


1904
1905
1906
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1904

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1911
1912
1913
1914
1915
1916
1917
1918
1919
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1911

def update!(**args)
  @done = args[:done] if args.key?(:done)
  @error = args[:error] if args.key?(:error)
  @kind = args[:kind] if args.key?(:kind)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @response = args[:response] if args.key?(:response)
  @self_link = args[:self_link] if args.key?(:self_link)
end