Class: Google::Apis::CloudfunctionsV1::GoogleCloudFunctionsV2OperationMetadata

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

Overview

Represents the metadata of the long-running operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudFunctionsV2OperationMetadata

Returns a new instance of GoogleCloudFunctionsV2OperationMetadata.



866
867
868
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 866

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) 


809
810
811
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 809

def api_version
  @api_version
end

#cancel_requested ⇒ Boolean Also known as: cancel_requested?

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 cancelRequested

Returns:

  • (Boolean) 


817
818
819
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 817

def cancel_requested
  @cancel_requested
end

#create_time ⇒ String

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

Returns:

  • (String) 


823
824
825
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 823

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


828
829
830
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 828

def end_time
  @end_time
end

#operation_type ⇒ String

The operation type. Corresponds to the JSON property operationType

Returns:

  • (String) 


833
834
835
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 833

def operation_type
  @operation_type
end

#request_resource ⇒ Hash<String,Object>

The original request that started the operation. Corresponds to the JSON property requestResource

Returns:

  • (Hash<String,Object>) 


838
839
840
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 838

def request_resource
  @request_resource
end

#source_token ⇒ String

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. Corresponds to the JSON property sourceToken

Returns:

  • (String) 


844
845
846
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 844

def source_token
  @source_token
end

#stages ⇒ Array<Google::Apis::CloudfunctionsV1::GoogleCloudFunctionsV2Stage>

Mechanism for reporting in-progress stages Corresponds to the JSON property stages

Returns:



849
850
851
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 849

def stages
  @stages
end

#status_detail ⇒ String

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

Returns:

  • (String) 


854
855
856
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 854

def status_detail
  @status_detail
end

#target ⇒ String

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

Returns:

  • (String) 


859
860
861
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 859

def target
  @target
end

#verb ⇒ String

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

Returns:

  • (String) 


864
865
866
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 864

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 871

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @operation_type = args[:operation_type] if args.key?(:operation_type)
  @request_resource = args[:request_resource] if args.key?(:request_resource)
  @source_token = args[:source_token] if args.key?(:source_token)
  @stages = args[:stages] if args.key?(:stages)
  @status_detail = args[:status_detail] if args.key?(:status_detail)
  @target = args[:target] if args.key?(:target)
  @verb = args[:verb] if args.key?(:verb)
end