API hub v1 API - Class ApiHubSettings (1.1.0)

public sealed class ApiHubSettings : ServiceSettingsBase

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

Settings for ApiHubClient instances.

Inheritance

object > ServiceSettingsBase > ApiHubSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ApiHubSettings()

public ApiHubSettings()

Constructs a new ApiHubSettings object with default settings.

Properties

CreateApiOperationSettings

public CallSettings CreateApiOperationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.CreateApiOperation and ApiHubClient.CreateApiOperationAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateApiSettings

public CallSettings CreateApiSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateAttributeSettings

public CallSettings CreateAttributeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.CreateAttribute and ApiHubClient.CreateAttributeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateDeploymentSettings

public CallSettings CreateDeploymentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.CreateDeployment and ApiHubClient.CreateDeploymentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateExternalApiSettings

public CallSettings CreateExternalApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.CreateExternalApi and ApiHubClient.CreateExternalApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateSpecSettings

public CallSettings CreateSpecSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.CreateSpec and ApiHubClient.CreateSpecAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateVersionSettings

public CallSettings CreateVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.CreateVersion and ApiHubClient.CreateVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteApiOperationSettings

public CallSettings DeleteApiOperationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.DeleteApiOperation and ApiHubClient.DeleteApiOperationAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteApiSettings

public CallSettings DeleteApiSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 300 seconds.

DeleteAttributeSettings

public CallSettings DeleteAttributeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.DeleteAttribute and ApiHubClient.DeleteAttributeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteDeploymentSettings

public CallSettings DeleteDeploymentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.DeleteDeployment and ApiHubClient.DeleteDeploymentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteExternalApiSettings

public CallSettings DeleteExternalApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.DeleteExternalApi and ApiHubClient.DeleteExternalApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteSpecSettings

public CallSettings DeleteSpecSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.DeleteSpec and ApiHubClient.DeleteSpecAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 300 seconds.

DeleteVersionSettings

public CallSettings DeleteVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.DeleteVersion and ApiHubClient.DeleteVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 300 seconds.

GetApiOperationSettings

public CallSettings GetApiOperationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetApiOperation and ApiHubClient.GetApiOperationAsync.

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.

GetApiSettings

public CallSettings GetApiSettings { get; set; }

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

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.

GetAttributeSettings

public CallSettings GetAttributeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetAttribute and ApiHubClient.GetAttributeAsync.

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.

GetDefinitionSettings

public CallSettings GetDefinitionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetDefinition and ApiHubClient.GetDefinitionAsync.

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.

GetDeploymentSettings

public CallSettings GetDeploymentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetDeployment and ApiHubClient.GetDeploymentAsync.

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.

GetExternalApiSettings

public CallSettings GetExternalApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetExternalApi and ApiHubClient.GetExternalApiAsync.

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.

GetSpecContentsSettings

public CallSettings GetSpecContentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetSpecContents and ApiHubClient.GetSpecContentsAsync.

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.

GetSpecSettings

public CallSettings GetSpecSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetSpec and ApiHubClient.GetSpecAsync.

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.

GetVersionSettings

public CallSettings GetVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.GetVersion and ApiHubClient.GetVersionAsync.

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.

ListApiOperationsSettings

public CallSettings ListApiOperationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.ListApiOperations and ApiHubClient.ListApiOperationsAsync.

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.

ListApisSettings

public CallSettings ListApisSettings { get; set; }

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

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.

ListAttributesSettings

public CallSettings ListAttributesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.ListAttributes and ApiHubClient.ListAttributesAsync.

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.

ListDeploymentsSettings

public CallSettings ListDeploymentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.ListDeployments and ApiHubClient.ListDeploymentsAsync.

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.

ListExternalApisSettings

public CallSettings ListExternalApisSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.ListExternalApis and ApiHubClient.ListExternalApisAsync.

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.

ListSpecsSettings

public CallSettings ListSpecsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.ListSpecs and ApiHubClient.ListSpecsAsync.

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.

ListVersionsSettings

public CallSettings ListVersionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.ListVersions and ApiHubClient.ListVersionsAsync.

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.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type	Description
`LocationsSettings`

SearchResourcesSettings

public CallSettings SearchResourcesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.SearchResources and ApiHubClient.SearchResourcesAsync.

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.

UpdateApiOperationSettings

public CallSettings UpdateApiOperationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.UpdateApiOperation and ApiHubClient.UpdateApiOperationAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateApiSettings

public CallSettings UpdateApiSettings { get; set; }

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

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateAttributeSettings

public CallSettings UpdateAttributeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.UpdateAttribute and ApiHubClient.UpdateAttributeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateDeploymentSettings

public CallSettings UpdateDeploymentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.UpdateDeployment and ApiHubClient.UpdateDeploymentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateExternalApiSettings

public CallSettings UpdateExternalApiSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.UpdateExternalApi and ApiHubClient.UpdateExternalApiAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateSpecSettings

public CallSettings UpdateSpecSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.UpdateSpec and ApiHubClient.UpdateSpecAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateVersionSettings

public CallSettings UpdateVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiHubClient.UpdateVersion and ApiHubClient.UpdateVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

Methods

Clone()

public ApiHubSettings Clone()

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

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

GetDefault()

public static ApiHubSettings GetDefault()

Get a new instance of the default ApiHubSettings.

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