API hub v1 API - Class ApiHubPluginSettings (1.1.0)

public sealed class ApiHubPluginSettings : ServiceSettingsBase

Reference documentation and code samples for the API hub v1 API class ApiHubPluginSettings.

Settings for ApiHubPluginClient instances.

Inheritance

object > ServiceSettingsBase > ApiHubPluginSettings

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ApiHubPluginSettings()

public ApiHubPluginSettings()

Constructs a new ApiHubPluginSettings object with default settings.

Properties

CreatePluginInstanceOperationsSettings

public OperationsSettings CreatePluginInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiHubPluginClient.CreatePluginInstance and ApiHubPluginClient.CreatePluginInstanceAsync.

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.

CreatePluginInstanceSettings

public CallSettings CreatePluginInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.CreatePluginInstance and ApiHubPluginClient.CreatePluginInstanceAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

CreatePluginSettings

public CallSettings CreatePluginSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.CreatePlugin and ApiHubPluginClient.CreatePluginAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

DeletePluginInstanceOperationsSettings

public OperationsSettings DeletePluginInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiHubPluginClient.DeletePluginInstance and ApiHubPluginClient.DeletePluginInstanceAsync.

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.

DeletePluginInstanceSettings

public CallSettings DeletePluginInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.DeletePluginInstance and ApiHubPluginClient.DeletePluginInstanceAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

DeletePluginOperationsSettings

public OperationsSettings DeletePluginOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiHubPluginClient.DeletePlugin and ApiHubPluginClient.DeletePluginAsync.

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.

DeletePluginSettings

public CallSettings DeletePluginSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.DeletePlugin and ApiHubPluginClient.DeletePluginAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

DisablePluginInstanceActionOperationsSettings

public OperationsSettings DisablePluginInstanceActionOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiHubPluginClient.DisablePluginInstanceAction and ApiHubPluginClient.DisablePluginInstanceActionAsync.

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.

DisablePluginInstanceActionSettings

public CallSettings DisablePluginInstanceActionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.DisablePluginInstanceAction and ApiHubPluginClient.DisablePluginInstanceActionAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

DisablePluginSettings

public CallSettings DisablePluginSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.DisablePlugin and ApiHubPluginClient.DisablePluginAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

EnablePluginInstanceActionOperationsSettings

public OperationsSettings EnablePluginInstanceActionOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiHubPluginClient.EnablePluginInstanceAction and ApiHubPluginClient.EnablePluginInstanceActionAsync.

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.

EnablePluginInstanceActionSettings

public CallSettings EnablePluginInstanceActionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.EnablePluginInstanceAction and ApiHubPluginClient.EnablePluginInstanceActionAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

EnablePluginSettings

public CallSettings EnablePluginSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.EnablePlugin and ApiHubPluginClient.EnablePluginAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

ExecutePluginInstanceActionOperationsSettings

public OperationsSettings ExecutePluginInstanceActionOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiHubPluginClient.ExecutePluginInstanceAction and ApiHubPluginClient.ExecutePluginInstanceActionAsync.

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.

ExecutePluginInstanceActionSettings

public CallSettings ExecutePluginInstanceActionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.ExecutePluginInstanceAction and ApiHubPluginClient.ExecutePluginInstanceActionAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

GetPluginInstanceSettings

public CallSettings GetPluginInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.GetPluginInstance and ApiHubPluginClient.GetPluginInstanceAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

GetPluginSettings

public CallSettings GetPluginSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.GetPlugin and ApiHubPluginClient.GetPluginAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable.
  • Timeout: 60 seconds.

ListPluginInstancesSettings

public CallSettings ListPluginInstancesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.ListPluginInstances and ApiHubPluginClient.ListPluginInstancesAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

ListPluginsSettings

public CallSettings ListPluginsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.ListPlugins and ApiHubPluginClient.ListPluginsAsync.

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

UpdatePluginInstanceSettings

public CallSettings UpdatePluginInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubPluginClient.UpdatePluginInstance and ApiHubPluginClient.UpdatePluginInstanceAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

Methods

Clone()

public ApiHubPluginSettings Clone()

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

Returns
Type Description
ApiHubPluginSettings

A deep clone of this ApiHubPluginSettings object.

GetDefault()

public static ApiHubPluginSettings GetDefault()

Get a new instance of the default ApiHubPluginSettings.

Returns
Type Description
ApiHubPluginSettings

A new instance of the default ApiHubPluginSettings.