Class: Google::Apis::ServicemanagementV1::FlowOperationMetadata

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

Overview

The metadata associated with a long running operation resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FlowOperationMetadata

Returns a new instance of FlowOperationMetadata



1624
1625
1626
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1624

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

Instance Attribute Details

#cancel_state ⇒ String

The state of the operation with respect to cancellation. Corresponds to the JSON property cancelState

Returns:

  • (String) 


1582
1583
1584
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1582

def cancel_state
  @cancel_state
end

#deadline ⇒ String

Deadline for the flow to complete, to prevent orphaned Operations. If the flow has not completed by this time, it may be terminated by the engine, or force-failed by Operation lookup. Note that this is not a hard deadline after which the Flow will definitely be failed, rather it is a deadline after which it is reasonable to suspect a problem and other parts of the system may kill operation to ensure we don't have orphans. see also: go/prevent-orphaned-operations Corresponds to the JSON property deadline

Returns:

  • (String) 


1594
1595
1596
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1594

def deadline
  @deadline
end

#flow_name ⇒ String

The name of the top-level flow corresponding to this operation. Must be equal to the "name" field for a FlowName enum. Corresponds to the JSON property flowName

Returns:

  • (String) 


1600
1601
1602
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1600

def flow_name
  @flow_name
end

#operation_type ⇒ Fixnum

Operation type which is a flow type and subtype info as that is missing in our datastore otherwise. This maps to the ordinal value of the enum: jcg/api/tenant/operations/OperationNamespace.java Corresponds to the JSON property operationType

Returns:

  • (Fixnum) 


1607
1608
1609
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1607

def operation_type
  @operation_type
end

#resource_names ⇒ Array<String>

The full name of the resources that this flow is directly associated with. Corresponds to the JSON property resourceNames

Returns:

  • (Array<String>) 


1612
1613
1614
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1612

def resource_names
  @resource_names
end

#start_time ⇒ String

The start time of the operation. Corresponds to the JSON property startTime

Returns:

  • (String) 


1617
1618
1619
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1617

def start_time
  @start_time
end

#surface ⇒ String

Corresponds to the JSON property surface

Returns:

  • (String) 


1622
1623
1624
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1622

def surface
  @surface
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1629
1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1629

def update!(**args)
  @cancel_state = args[:cancel_state] if args.key?(:cancel_state)
  @deadline = args[:deadline] if args.key?(:deadline)
  @flow_name = args[:flow_name] if args.key?(:flow_name)
  @operation_type = args[:operation_type] if args.key?(:operation_type)
  @resource_names = args[:resource_names] if args.key?(:resource_names)
  @start_time = args[:start_time] if args.key?(:start_time)
  @surface = args[:surface] if args.key?(:surface)
end