Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1FlowHook

Returns a new instance of GoogleCloudApigeeV1FlowHook.



5543
5544
5545
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5543

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

Instance Attribute Details

#continue_on_error ⇒ Boolean Also known as: continue_on_error?

Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true. Corresponds to the JSON property continueOnError

Returns:

  • (Boolean) 


5523
5524
5525
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5523

def continue_on_error
  @continue_on_error
end

#description ⇒ String

Description of the flow hook. Corresponds to the JSON property description

Returns:

  • (String) 


5529
5530
5531
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5529

def description
  @description
end

#flow_hook_point ⇒ String

Output only. Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook. Corresponds to the JSON property flowHookPoint

Returns:

  • (String) 


5536
5537
5538
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5536

def flow_hook_point
  @flow_hook_point
end

#shared_flow ⇒ String

Shared flow attached to this flow hook, or empty if there is none attached. Corresponds to the JSON property sharedFlow

Returns:

  • (String) 


5541
5542
5543
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5541

def shared_flow
  @shared_flow
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5548
5549
5550
5551
5552
5553
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5548

def update!(**args)
  @continue_on_error = args[:continue_on_error] if args.key?(:continue_on_error)
  @description = args[:description] if args.key?(:description)
  @flow_hook_point = args[:flow_hook_point] if args.key?(:flow_hook_point)
  @shared_flow = args[:shared_flow] if args.key?(:shared_flow)
end