Workflows v1 API - Class WorkflowsSettings (2.5.0)

public sealed class WorkflowsSettings : ServiceSettingsBase

Reference documentation and code samples for the Workflows v1 API class WorkflowsSettings.

Settings for WorkflowsClient instances.

Inheritance

object > ServiceSettingsBase > WorkflowsSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Workflows.V1

Assembly

Google.Cloud.Workflows.V1.dll

Constructors

WorkflowsSettings()

public WorkflowsSettings()

Constructs a new WorkflowsSettings object with default settings.

Properties

CreateWorkflowOperationsSettings

public OperationsSettings CreateWorkflowOperationsSettings { get; set; }

Long Running Operation settings for calls to WorkflowsClient.CreateWorkflow and WorkflowsClient.CreateWorkflowAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateWorkflowSettings

public CallSettings CreateWorkflowSettings { get; set; }

CallSettings for synchronous and asynchronous calls to WorkflowsClient.CreateWorkflow and WorkflowsClient.CreateWorkflowAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeleteWorkflowOperationsSettings

public OperationsSettings DeleteWorkflowOperationsSettings { get; set; }

Long Running Operation settings for calls to WorkflowsClient.DeleteWorkflow and WorkflowsClient.DeleteWorkflowAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteWorkflowSettings

public CallSettings DeleteWorkflowSettings { get; set; }

CallSettings for synchronous and asynchronous calls to WorkflowsClient.DeleteWorkflow and WorkflowsClient.DeleteWorkflowAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetWorkflowSettings

public CallSettings GetWorkflowSettings { get; set; }

CallSettings for synchronous and asynchronous calls to WorkflowsClient.GetWorkflow and WorkflowsClient.GetWorkflowAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListWorkflowsSettings

public CallSettings ListWorkflowsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to WorkflowsClient.ListWorkflows and WorkflowsClient.ListWorkflowsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
`LocationsSettings`

UpdateWorkflowOperationsSettings

public OperationsSettings UpdateWorkflowOperationsSettings { get; set; }

Long Running Operation settings for calls to WorkflowsClient.UpdateWorkflow and WorkflowsClient.UpdateWorkflowAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpdateWorkflowSettings

public CallSettings UpdateWorkflowSettings { get; set; }

CallSettings for synchronous and asynchronous calls to WorkflowsClient.UpdateWorkflow and WorkflowsClient.UpdateWorkflowAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

Methods

Clone()

public WorkflowsSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type	Description
`WorkflowsSettings`	A deep clone of this WorkflowsSettings object.

GetDefault()

public static WorkflowsSettings GetDefault()

Get a new instance of the default WorkflowsSettings.

Returns
Type	Description
`WorkflowsSettings`	A new instance of the default WorkflowsSettings.