Class: Temporalio::Client::RPCOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/client.rb

Overview

Set of RPC options for RPC calls.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata: nil, timeout: nil, cancellation: nil, override_retry: nil) ⇒ RPCOptions

Create RPC options.

Parameters:

  • metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout of the RPC call.

  • cancellation (Cancellation, nil) (defaults to: nil) —

    Cancellation to use to potentially cancel the call. If canceled, the RPC will return Error::CanceledError.

  • override_retry (Boolean, nil) (defaults to: nil) —

    Whether to override the default retry option which decides whether to retry calls implicitly when known transient error codes are reached. By default when this is nil, high-level calls retry known transient error codes and low-level/direct calls do not.



974
975
976
977
978
979
980
981
982
983
984
 
# File 'lib/temporalio/client.rb', line 974

def initialize(
  metadata: nil,
  timeout: nil,
  cancellation: nil,
  override_retry: nil
)
  @metadata = metadata
  @timeout = timeout
  @cancellation = cancellation
  @override_retry = override_retry
end

Instance Attribute Details

#cancellation ⇒ Cancellation?

Returns Cancellation to use to potentially cancel the call. If canceled, the RPC will return Error::CanceledError.

Returns:



958
959
960
 
# File 'lib/temporalio/client.rb', line 958

def cancellation
  @cancellation
end

#metadata ⇒ Hash<String, String>?

Returns Headers to include on the RPC call.

Returns:

  • (Hash<String, String>, nil) —

    Headers to include on the RPC call.



951
952
953
 
# File 'lib/temporalio/client.rb', line 951

def metadata
  @metadata
end

#override_retry ⇒ Boolean?

Returns Whether to override the default retry option which decides whether to retry calls implicitly when known transient error codes are reached. By default when this is nil, high-level calls retry known transient error codes and low-level/direct calls do not.

Returns:

  • (Boolean, nil) —

    Whether to override the default retry option which decides whether to retry calls implicitly when known transient error codes are reached. By default when this is nil, high-level calls retry known transient error codes and low-level/direct calls do not.



963
964
965
 
# File 'lib/temporalio/client.rb', line 963

def override_retry
  @override_retry
end

#timeout ⇒ Float?

Returns Number of seconds before timeout of the RPC call.

Returns:

  • (Float, nil) —

    Number of seconds before timeout of the RPC call.



954
955
956
 
# File 'lib/temporalio/client.rb', line 954

def timeout
  @timeout
end