Cloud Dataplex v1 API - Class DataplexServiceSettings (2.5.0)

public sealed class DataplexServiceSettings : ServiceSettingsBase

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

Settings for DataplexServiceClient instances.

Inheritance

object > ServiceSettingsBase > DataplexServiceSettings

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

DataplexServiceSettings()

public DataplexServiceSettings()

Constructs a new DataplexServiceSettings object with default settings.

Properties

CancelJobSettings

public CallSettings CancelJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.CancelJob and DataplexServiceClient.CancelJobAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateAssetOperationsSettings

public OperationsSettings CreateAssetOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.CreateAsset and DataplexServiceClient.CreateAssetAsync.

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.

CreateAssetSettings

public CallSettings CreateAssetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.CreateAsset and DataplexServiceClient.CreateAssetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateEnvironmentOperationsSettings

public OperationsSettings CreateEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.CreateEnvironment and DataplexServiceClient.CreateEnvironmentAsync.

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.

CreateEnvironmentSettings

public CallSettings CreateEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.CreateEnvironment and DataplexServiceClient.CreateEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateLakeOperationsSettings

public OperationsSettings CreateLakeOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.CreateLake and DataplexServiceClient.CreateLakeAsync.

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.

CreateLakeSettings

public CallSettings CreateLakeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.CreateLake and DataplexServiceClient.CreateLakeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateTaskOperationsSettings

public OperationsSettings CreateTaskOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.CreateTask and DataplexServiceClient.CreateTaskAsync.

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.

CreateTaskSettings

public CallSettings CreateTaskSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.CreateTask and DataplexServiceClient.CreateTaskAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateZoneOperationsSettings

public OperationsSettings CreateZoneOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.CreateZone and DataplexServiceClient.CreateZoneAsync.

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.

CreateZoneSettings

public CallSettings CreateZoneSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.CreateZone and DataplexServiceClient.CreateZoneAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteAssetOperationsSettings

public OperationsSettings DeleteAssetOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.DeleteAsset and DataplexServiceClient.DeleteAssetAsync.

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.

DeleteAssetSettings

public CallSettings DeleteAssetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.DeleteAsset and DataplexServiceClient.DeleteAssetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteEnvironmentOperationsSettings

public OperationsSettings DeleteEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.DeleteEnvironment and DataplexServiceClient.DeleteEnvironmentAsync.

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.

DeleteEnvironmentSettings

public CallSettings DeleteEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.DeleteEnvironment and DataplexServiceClient.DeleteEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteLakeOperationsSettings

public OperationsSettings DeleteLakeOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.DeleteLake and DataplexServiceClient.DeleteLakeAsync.

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.

DeleteLakeSettings

public CallSettings DeleteLakeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.DeleteLake and DataplexServiceClient.DeleteLakeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteTaskOperationsSettings

public OperationsSettings DeleteTaskOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.DeleteTask and DataplexServiceClient.DeleteTaskAsync.

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.

DeleteTaskSettings

public CallSettings DeleteTaskSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.DeleteTask and DataplexServiceClient.DeleteTaskAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteZoneOperationsSettings

public OperationsSettings DeleteZoneOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.DeleteZone and DataplexServiceClient.DeleteZoneAsync.

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.

DeleteZoneSettings

public CallSettings DeleteZoneSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.DeleteZone and DataplexServiceClient.DeleteZoneAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetAssetSettings

public CallSettings GetAssetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.GetAsset and DataplexServiceClient.GetAssetAsync.

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.

GetEnvironmentSettings

public CallSettings GetEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.GetEnvironment and DataplexServiceClient.GetEnvironmentAsync.

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.

GetJobSettings

public CallSettings GetJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.GetJob and DataplexServiceClient.GetJobAsync.

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.

GetLakeSettings

public CallSettings GetLakeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.GetLake and DataplexServiceClient.GetLakeAsync.

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.

GetTaskSettings

public CallSettings GetTaskSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.GetTask and DataplexServiceClient.GetTaskAsync.

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.

GetZoneSettings

public CallSettings GetZoneSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.GetZone and DataplexServiceClient.GetZoneAsync.

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.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

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

Property Value
Type	Description
`IAMPolicySettings`

ListAssetActionsSettings

public CallSettings ListAssetActionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListAssetActions and DataplexServiceClient.ListAssetActionsAsync.

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.

ListAssetsSettings

public CallSettings ListAssetsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListAssets and DataplexServiceClient.ListAssetsAsync.

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.

ListEnvironmentsSettings

public CallSettings ListEnvironmentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListEnvironments and DataplexServiceClient.ListEnvironmentsAsync.

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.

ListJobsSettings

public CallSettings ListJobsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListJobs and DataplexServiceClient.ListJobsAsync.

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.

ListLakeActionsSettings

public CallSettings ListLakeActionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListLakeActions and DataplexServiceClient.ListLakeActionsAsync.

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.

ListLakesSettings

public CallSettings ListLakesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListLakes and DataplexServiceClient.ListLakesAsync.

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.

ListSessionsSettings

public CallSettings ListSessionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListSessions and DataplexServiceClient.ListSessionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

ListTasksSettings

public CallSettings ListTasksSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListTasks and DataplexServiceClient.ListTasksAsync.

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.

ListZoneActionsSettings

public CallSettings ListZoneActionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListZoneActions and DataplexServiceClient.ListZoneActionsAsync.

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.

ListZonesSettings

public CallSettings ListZonesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.ListZones and DataplexServiceClient.ListZonesAsync.

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`

RunTaskSettings

public CallSettings RunTaskSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.RunTask and DataplexServiceClient.RunTaskAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateAssetOperationsSettings

public OperationsSettings UpdateAssetOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.UpdateAsset and DataplexServiceClient.UpdateAssetAsync.

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.

UpdateAssetSettings

public CallSettings UpdateAssetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.UpdateAsset and DataplexServiceClient.UpdateAssetAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateEnvironmentOperationsSettings

public OperationsSettings UpdateEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.UpdateEnvironment and DataplexServiceClient.UpdateEnvironmentAsync.

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.

UpdateEnvironmentSettings

public CallSettings UpdateEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.UpdateEnvironment and DataplexServiceClient.UpdateEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateLakeOperationsSettings

public OperationsSettings UpdateLakeOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.UpdateLake and DataplexServiceClient.UpdateLakeAsync.

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.

UpdateLakeSettings

public CallSettings UpdateLakeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.UpdateLake and DataplexServiceClient.UpdateLakeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateTaskOperationsSettings

public OperationsSettings UpdateTaskOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.UpdateTask and DataplexServiceClient.UpdateTaskAsync.

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.

UpdateTaskSettings

public CallSettings UpdateTaskSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.UpdateTask and DataplexServiceClient.UpdateTaskAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateZoneOperationsSettings

public OperationsSettings UpdateZoneOperationsSettings { get; set; }

Long Running Operation settings for calls to DataplexServiceClient.UpdateZone and DataplexServiceClient.UpdateZoneAsync.

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.

UpdateZoneSettings

public CallSettings UpdateZoneSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DataplexServiceClient.UpdateZone and DataplexServiceClient.UpdateZoneAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

Methods

Clone()

public DataplexServiceSettings Clone()

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

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

GetDefault()

public static DataplexServiceSettings GetDefault()

Get a new instance of the default DataplexServiceSettings.

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