Class OperationsSettings

Settings for a OperationsClient.

Inheritance

System.Object

ServiceSettingsBase

OperationsSettings

Inherited Members

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.LongRunning

Assembly: Google.LongRunning.dll

Syntax

public sealed class OperationsSettings : ServiceSettingsBase

Constructors

OperationsSettings()

Constructs a new OperationsSettings object with default settings.

Declaration

public OperationsSettings()

Properties

CancelOperationSettings

CallSettings for synchronous and asynchronous calls to OperationsClient.CancelOperation and OperationsClient.CancelOperationAsync.

Declaration

public CallSettings CancelOperationSettings { get; set; }

Property Value

Type	Description
CallSettings

Remarks

The default OperationsClient.CancelOperation and OperationsClient.CancelOperationAsync RetrySettings are:

• Initial retry delay: 100 milliseconds
• Retry delay multiplier: 1.3
• Retry maximum delay: 60000 milliseconds
• Initial timeout: 90000 milliseconds
• Timeout multiplier: 1.0
• Timeout maximum delay: 90000 milliseconds

Retry will be attempted on the following response status codes:

Default RPC expiration is 600000 milliseconds.

DefaultPollSettings

The poll settings used by default for repeated polling operations.

Declaration

public PollSettings DefaultPollSettings { get; set; }

Property Value

Type	Description
PollSettings

DeleteOperationSettings

CallSettings for synchronous and asynchronous calls to OperationsClient.DeleteOperation and OperationsClient.DeleteOperationAsync.

Declaration

public CallSettings DeleteOperationSettings { get; set; }

Property Value

Type	Description
CallSettings

Remarks

The default OperationsClient.DeleteOperation and OperationsClient.DeleteOperationAsync RetrySettings are:

• Initial retry delay: 100 milliseconds
• Retry delay multiplier: 1.3
• Retry maximum delay: 60000 milliseconds
• Initial timeout: 90000 milliseconds
• Timeout multiplier: 1.0
• Timeout maximum delay: 90000 milliseconds

Retry will be attempted on the following response status codes:

Default RPC expiration is 600000 milliseconds.

GetOperationSettings

CallSettings for synchronous and asynchronous calls to OperationsClient.GetOperation and OperationsClient.GetOperationAsync.

Declaration

public CallSettings GetOperationSettings { get; set; }

Property Value

Type	Description
CallSettings

Remarks

The default OperationsClient.GetOperation and OperationsClient.GetOperationAsync RetrySettings are:

• Initial retry delay: 100 milliseconds
• Retry delay multiplier: 1.3
• Retry maximum delay: 60000 milliseconds
• Initial timeout: 90000 milliseconds
• Timeout multiplier: 1.0
• Timeout maximum delay: 90000 milliseconds

Retry will be attempted on the following response status codes:

Default RPC expiration is 600000 milliseconds.

IdempotentRetryFilter

The filter specifying which RPC StatusCodes are eligible for retry for "Idempotent" OperationsClient RPC methods.

Declaration

public static Predicate<RpcException> IdempotentRetryFilter { get; }

Property Value

Type	Description
System.Predicate<RpcException>

Remarks

The eligible RPC StatusCodes for retry for "Idempotent" RPC methods are:

• DeadlineExceeded
• Unavailable

ListOperationsSettings

CallSettings for synchronous and asynchronous calls to OperationsClient.ListOperations and OperationsClient.ListOperationsAsync.

Declaration

public CallSettings ListOperationsSettings { get; set; }

Property Value

Type	Description
CallSettings

Remarks

The default OperationsClient.ListOperations and OperationsClient.ListOperationsAsync RetrySettings are:

• Initial retry delay: 100 milliseconds
• Retry delay multiplier: 1.3
• Retry maximum delay: 60000 milliseconds
• Initial timeout: 90000 milliseconds
• Timeout multiplier: 1.0
• Timeout maximum delay: 90000 milliseconds

Retry will be attempted on the following response status codes:

Default RPC expiration is 600000 milliseconds.

NonIdempotentRetryFilter

The filter specifying which RPC StatusCodes are eligible for retry for "NonIdempotent" OperationsClient RPC methods.

Declaration

public static Predicate<RpcException> NonIdempotentRetryFilter { get; }

Property Value

Type	Description
System.Predicate<RpcException>

Remarks

There are no RPC StatusCodes eligible for retry for "NonIdempotent" RPC methods.

Methods

Clone()

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

Declaration

public OperationsSettings Clone()

Returns

Type	Description
OperationsSettings	A deep clone of this OperationsSettings object.

GetDefault()

Get a new instance of the default OperationsSettings.

Declaration

public static OperationsSettings GetDefault()

Returns

Type	Description
OperationsSettings	A new instance of the default OperationsSettings.

GetDefaultRetryBackoff()

"Default" retry backoff for OperationsClient RPC methods.

Declaration

public static BackoffSettings GetDefaultRetryBackoff()

Returns

Type	Description
BackoffSettings	The "Default" retry backoff for OperationsClient RPC methods.

Remarks

The "Default" retry backoff for OperationsClient RPC methods is defined as:

• Initial delay: 100 milliseconds
• Maximum delay: 60000 milliseconds
• Delay multiplier: 1.3

GetDefaultTimeoutBackoff()

"Default" timeout backoff for OperationsClient RPC methods.

Declaration

public static BackoffSettings GetDefaultTimeoutBackoff()

Returns

Type	Description
BackoffSettings	The "Default" timeout backoff for OperationsClient RPC methods.

Remarks

The "Default" timeout backoff for OperationsClient RPC methods is defined as:

• Initial timeout: 90000 milliseconds
• Timeout multiplier: 1.0
• Maximum timeout: 90000 milliseconds