Cloud Dataplex v1 API - Class CatalogServiceSettings (3.4.0)

public sealed class CatalogServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud Dataplex v1 API class CatalogServiceSettings.

Settings for CatalogServiceClient instances.

Inheritance

object > ServiceSettingsBase > CatalogServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

CatalogServiceSettings()

public CatalogServiceSettings()

Constructs a new CatalogServiceSettings object with default settings.

Properties

CancelMetadataJobSettings

public CallSettings CancelMetadataJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.CancelMetadataJob and CatalogServiceClient.CancelMetadataJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateAspectTypeOperationsSettings

public OperationsSettings CreateAspectTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.CreateAspectType and CatalogServiceClient.CreateAspectTypeAsync.

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.

CreateAspectTypeSettings

public CallSettings CreateAspectTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.CreateAspectType and CatalogServiceClient.CreateAspectTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateEntryGroupOperationsSettings

public OperationsSettings CreateEntryGroupOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.CreateEntryGroup and CatalogServiceClient.CreateEntryGroupAsync.

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.

CreateEntryGroupSettings

public CallSettings CreateEntryGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.CreateEntryGroup and CatalogServiceClient.CreateEntryGroupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateEntrySettings

public CallSettings CreateEntrySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.CreateEntry and CatalogServiceClient.CreateEntryAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateEntryTypeOperationsSettings

public OperationsSettings CreateEntryTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.CreateEntryType and CatalogServiceClient.CreateEntryTypeAsync.

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.

CreateEntryTypeSettings

public CallSettings CreateEntryTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.CreateEntryType and CatalogServiceClient.CreateEntryTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateMetadataJobOperationsSettings

public OperationsSettings CreateMetadataJobOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.CreateMetadataJob and CatalogServiceClient.CreateMetadataJobAsync.

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.

CreateMetadataJobSettings

public CallSettings CreateMetadataJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.CreateMetadataJob and CatalogServiceClient.CreateMetadataJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteAspectTypeOperationsSettings

public OperationsSettings DeleteAspectTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.DeleteAspectType and CatalogServiceClient.DeleteAspectTypeAsync.

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.

DeleteAspectTypeSettings

public CallSettings DeleteAspectTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.DeleteAspectType and CatalogServiceClient.DeleteAspectTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteEntryGroupOperationsSettings

public OperationsSettings DeleteEntryGroupOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.DeleteEntryGroup and CatalogServiceClient.DeleteEntryGroupAsync.

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.

DeleteEntryGroupSettings

public CallSettings DeleteEntryGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.DeleteEntryGroup and CatalogServiceClient.DeleteEntryGroupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteEntrySettings

public CallSettings DeleteEntrySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.DeleteEntry and CatalogServiceClient.DeleteEntryAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteEntryTypeOperationsSettings

public OperationsSettings DeleteEntryTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.DeleteEntryType and CatalogServiceClient.DeleteEntryTypeAsync.

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.

DeleteEntryTypeSettings

public CallSettings DeleteEntryTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.DeleteEntryType and CatalogServiceClient.DeleteEntryTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetAspectTypeSettings

public CallSettings GetAspectTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.GetAspectType and CatalogServiceClient.GetAspectTypeAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

GetEntryGroupSettings

public CallSettings GetEntryGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.GetEntryGroup and CatalogServiceClient.GetEntryGroupAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

GetEntrySettings

public CallSettings GetEntrySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.GetEntry and CatalogServiceClient.GetEntryAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 10000 milliseconds.
Maximum attempts: 3
Retriable status codes: Unavailable, ResourceExhausted.
Timeout: 20 seconds.

GetEntryTypeSettings

public CallSettings GetEntryTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.GetEntryType and CatalogServiceClient.GetEntryTypeAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

GetMetadataJobSettings

public CallSettings GetMetadataJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.GetMetadataJob and CatalogServiceClient.GetMetadataJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

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

Property Value
Type	Description
`IAMPolicySettings`

ListAspectTypesSettings

public CallSettings ListAspectTypesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.ListAspectTypes and CatalogServiceClient.ListAspectTypesAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

ListEntriesSettings

public CallSettings ListEntriesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.ListEntries and CatalogServiceClient.ListEntriesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 10000 milliseconds.
Maximum attempts: 3
Retriable status codes: Unavailable, ResourceExhausted.
Timeout: 20 seconds.

ListEntryGroupsSettings

public CallSettings ListEntryGroupsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.ListEntryGroups and CatalogServiceClient.ListEntryGroupsAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

ListEntryTypesSettings

public CallSettings ListEntryTypesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.ListEntryTypes and CatalogServiceClient.ListEntryTypesAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

ListMetadataJobsSettings

public CallSettings ListMetadataJobsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.ListMetadataJobs and CatalogServiceClient.ListMetadataJobsAsync.

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`

LookupEntrySettings

public CallSettings LookupEntrySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.LookupEntry and CatalogServiceClient.LookupEntryAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 10000 milliseconds.
Maximum attempts: 3
Retriable status codes: Unavailable, ResourceExhausted.
Timeout: 20 seconds.

SearchEntriesSettings

public CallSettings SearchEntriesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.SearchEntries and CatalogServiceClient.SearchEntriesAsync.

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, ResourceExhausted.
Timeout: 60 seconds.

UpdateAspectTypeOperationsSettings

public OperationsSettings UpdateAspectTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.UpdateAspectType and CatalogServiceClient.UpdateAspectTypeAsync.

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.

UpdateAspectTypeSettings

public CallSettings UpdateAspectTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.UpdateAspectType and CatalogServiceClient.UpdateAspectTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateEntryGroupOperationsSettings

public OperationsSettings UpdateEntryGroupOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.UpdateEntryGroup and CatalogServiceClient.UpdateEntryGroupAsync.

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.

UpdateEntryGroupSettings

public CallSettings UpdateEntryGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.UpdateEntryGroup and CatalogServiceClient.UpdateEntryGroupAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateEntrySettings

public CallSettings UpdateEntrySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.UpdateEntry and CatalogServiceClient.UpdateEntryAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 1000 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 10000 milliseconds.
Maximum attempts: 3
Retriable status codes: Unavailable, ResourceExhausted.
Timeout: 60 seconds.

UpdateEntryTypeOperationsSettings

public OperationsSettings UpdateEntryTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to CatalogServiceClient.UpdateEntryType and CatalogServiceClient.UpdateEntryTypeAsync.

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.

UpdateEntryTypeSettings

public CallSettings UpdateEntryTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CatalogServiceClient.UpdateEntryType and CatalogServiceClient.UpdateEntryTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

Methods

Clone()

public CatalogServiceSettings Clone()

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

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

GetDefault()

public static CatalogServiceSettings GetDefault()

Get a new instance of the default CatalogServiceSettings.

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