API Gateway v1 API - Class ApiGatewayServiceSettings (2.4.0)

public sealed class ApiGatewayServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the API Gateway v1 API class ApiGatewayServiceSettings.

Settings for ApiGatewayServiceClient instances.

Inheritance

object > ServiceSettingsBase > ApiGatewayServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ApiGatewayServiceSettings()

public ApiGatewayServiceSettings()

Constructs a new ApiGatewayServiceSettings object with default settings.

Properties

CreateApiConfigOperationsSettings

public OperationsSettings CreateApiConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.CreateApiConfig and ApiGatewayServiceClient.CreateApiConfigAsync.

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.

CreateApiConfigSettings

public CallSettings CreateApiConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.CreateApiConfig and ApiGatewayServiceClient.CreateApiConfigAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

CreateApiOperationsSettings

public OperationsSettings CreateApiOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.CreateApi and ApiGatewayServiceClient.CreateApiAsync.

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.

CreateApiSettings

public CallSettings CreateApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.CreateApi and ApiGatewayServiceClient.CreateApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

CreateGatewayOperationsSettings

public OperationsSettings CreateGatewayOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.CreateGateway and ApiGatewayServiceClient.CreateGatewayAsync.

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.

CreateGatewaySettings

public CallSettings CreateGatewaySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.CreateGateway and ApiGatewayServiceClient.CreateGatewayAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

DeleteApiConfigOperationsSettings

public OperationsSettings DeleteApiConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.DeleteApiConfig and ApiGatewayServiceClient.DeleteApiConfigAsync.

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.

DeleteApiConfigSettings

public CallSettings DeleteApiConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.DeleteApiConfig and ApiGatewayServiceClient.DeleteApiConfigAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

DeleteApiOperationsSettings

public OperationsSettings DeleteApiOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.DeleteApi and ApiGatewayServiceClient.DeleteApiAsync.

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.

DeleteApiSettings

public CallSettings DeleteApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.DeleteApi and ApiGatewayServiceClient.DeleteApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

DeleteGatewayOperationsSettings

public OperationsSettings DeleteGatewayOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.DeleteGateway and ApiGatewayServiceClient.DeleteGatewayAsync.

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.

DeleteGatewaySettings

public CallSettings DeleteGatewaySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.DeleteGateway and ApiGatewayServiceClient.DeleteGatewayAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

GetApiConfigSettings

public CallSettings GetApiConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.GetApiConfig and ApiGatewayServiceClient.GetApiConfigAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetApiSettings

public CallSettings GetApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.GetApi and ApiGatewayServiceClient.GetApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetGatewaySettings

public CallSettings GetGatewaySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.GetGateway and ApiGatewayServiceClient.GetGatewayAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ListApiConfigsSettings

public CallSettings ListApiConfigsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.ListApiConfigs and ApiGatewayServiceClient.ListApiConfigsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ListApisSettings

public CallSettings ListApisSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.ListApis and ApiGatewayServiceClient.ListApisAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ListGatewaysSettings

public CallSettings ListGatewaysSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.ListGateways and ApiGatewayServiceClient.ListGatewaysAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateApiConfigOperationsSettings

public OperationsSettings UpdateApiConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.UpdateApiConfig and ApiGatewayServiceClient.UpdateApiConfigAsync.

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.

UpdateApiConfigSettings

public CallSettings UpdateApiConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.UpdateApiConfig and ApiGatewayServiceClient.UpdateApiConfigAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

UpdateApiOperationsSettings

public OperationsSettings UpdateApiOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.UpdateApi and ApiGatewayServiceClient.UpdateApiAsync.

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.

UpdateApiSettings

public CallSettings UpdateApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.UpdateApi and ApiGatewayServiceClient.UpdateApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

UpdateGatewayOperationsSettings

public OperationsSettings UpdateGatewayOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiGatewayServiceClient.UpdateGateway and ApiGatewayServiceClient.UpdateGatewayAsync.

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.

UpdateGatewaySettings

public CallSettings UpdateGatewaySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiGatewayServiceClient.UpdateGateway and ApiGatewayServiceClient.UpdateGatewayAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 2
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unknown, Unavailable.
Timeout: 60 seconds.

Methods

Clone()

public ApiGatewayServiceSettings Clone()

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

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

GetDefault()

public static ApiGatewayServiceSettings GetDefault()

Get a new instance of the default ApiGatewayServiceSettings.

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