Cloud Composer v1 API - Class EnvironmentsSettings (2.9.0) 

public sealed class EnvironmentsSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud Composer v1 API class EnvironmentsSettings.

Settings for EnvironmentsClient instances.

Inheritance

object > ServiceSettingsBase > EnvironmentsSettings

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Constructors

EnvironmentsSettings()

public EnvironmentsSettings()

Constructs a new EnvironmentsSettings object with default settings.

Properties

CheckUpgradeOperationsSettings

public OperationsSettings CheckUpgradeOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.CheckUpgrade and EnvironmentsClient.CheckUpgradeAsync.

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.

CheckUpgradeSettings

public CallSettings CheckUpgradeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.CheckUpgrade and EnvironmentsClient.CheckUpgradeAsync.

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

CreateEnvironmentOperationsSettings

public OperationsSettings CreateEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.CreateEnvironment and EnvironmentsClient.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 EnvironmentsClient.CreateEnvironment and EnvironmentsClient.CreateEnvironmentAsync.

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

CreateUserWorkloadsConfigMapSettings

public CallSettings CreateUserWorkloadsConfigMapSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.CreateUserWorkloadsConfigMap and EnvironmentsClient.CreateUserWorkloadsConfigMapAsync.

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

CreateUserWorkloadsSecretSettings

public CallSettings CreateUserWorkloadsSecretSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.CreateUserWorkloadsSecret and EnvironmentsClient.CreateUserWorkloadsSecretAsync .

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

DatabaseFailoverOperationsSettings

public OperationsSettings DatabaseFailoverOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.DatabaseFailover and EnvironmentsClient.DatabaseFailoverAsync.

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.

DatabaseFailoverSettings

public CallSettings DatabaseFailoverSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.DatabaseFailover and EnvironmentsClient.DatabaseFailoverAsync.

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

DeleteEnvironmentOperationsSettings

public OperationsSettings DeleteEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.DeleteEnvironment and EnvironmentsClient.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 EnvironmentsClient.DeleteEnvironment and EnvironmentsClient.DeleteEnvironmentAsync.

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

DeleteUserWorkloadsConfigMapSettings

public CallSettings DeleteUserWorkloadsConfigMapSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.DeleteUserWorkloadsConfigMap and EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync.

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

DeleteUserWorkloadsSecretSettings

public CallSettings DeleteUserWorkloadsSecretSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.DeleteUserWorkloadsSecret and EnvironmentsClient.DeleteUserWorkloadsSecretAsync .

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

ExecuteAirflowCommandSettings

public CallSettings ExecuteAirflowCommandSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.ExecuteAirflowCommand and EnvironmentsClient.ExecuteAirflowCommandAsync.

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

FetchDatabasePropertiesSettings

public CallSettings FetchDatabasePropertiesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.FetchDatabaseProperties and EnvironmentsClient.FetchDatabasePropertiesAsync .

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

GetEnvironmentSettings

public CallSettings GetEnvironmentSettings { get; set; }

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

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

GetUserWorkloadsConfigMapSettings

public CallSettings GetUserWorkloadsConfigMapSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.GetUserWorkloadsConfigMap and EnvironmentsClient.GetUserWorkloadsConfigMapAsync .

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

GetUserWorkloadsSecretSettings

public CallSettings GetUserWorkloadsSecretSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.GetUserWorkloadsSecret and EnvironmentsClient.GetUserWorkloadsSecretAsync.

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

ListEnvironmentsSettings

public CallSettings ListEnvironmentsSettings { get; set; }

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

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

ListUserWorkloadsConfigMapsSettings

public CallSettings ListUserWorkloadsConfigMapsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.ListUserWorkloadsConfigMaps and EnvironmentsClient.ListUserWorkloadsConfigMapsAsync.

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

ListUserWorkloadsSecretsSettings

public CallSettings ListUserWorkloadsSecretsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.ListUserWorkloadsSecrets and EnvironmentsClient.ListUserWorkloadsSecretsAsync .

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

ListWorkloadsSettings

public CallSettings ListWorkloadsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.ListWorkloads and EnvironmentsClient.ListWorkloadsAsync.

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

LoadSnapshotOperationsSettings

public OperationsSettings LoadSnapshotOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.LoadSnapshot and EnvironmentsClient.LoadSnapshotAsync.

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.

LoadSnapshotSettings

public CallSettings LoadSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.LoadSnapshot and EnvironmentsClient.LoadSnapshotAsync.

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

PollAirflowCommandSettings

public CallSettings PollAirflowCommandSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.PollAirflowCommand and EnvironmentsClient.PollAirflowCommandAsync.

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

SaveSnapshotOperationsSettings

public OperationsSettings SaveSnapshotOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.SaveSnapshot and EnvironmentsClient.SaveSnapshotAsync.

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.

SaveSnapshotSettings

public CallSettings SaveSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.SaveSnapshot and EnvironmentsClient.SaveSnapshotAsync.

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

StopAirflowCommandSettings

public CallSettings StopAirflowCommandSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.StopAirflowCommand and EnvironmentsClient.StopAirflowCommandAsync.

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

UpdateEnvironmentOperationsSettings

public OperationsSettings UpdateEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to EnvironmentsClient.UpdateEnvironment and EnvironmentsClient.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 EnvironmentsClient.UpdateEnvironment and EnvironmentsClient.UpdateEnvironmentAsync.

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

UpdateUserWorkloadsConfigMapSettings

public CallSettings UpdateUserWorkloadsConfigMapSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.UpdateUserWorkloadsConfigMap and EnvironmentsClient.UpdateUserWorkloadsConfigMapAsync.

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

UpdateUserWorkloadsSecretSettings

public CallSettings UpdateUserWorkloadsSecretSettings { get; set; }

CallSettings for synchronous and asynchronous calls to EnvironmentsClient.UpdateUserWorkloadsSecret and EnvironmentsClient.UpdateUserWorkloadsSecretAsync .

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

Methods

Clone()

public EnvironmentsSettings Clone()

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

Returns
Type Description
EnvironmentsSettings

A deep clone of this EnvironmentsSettings object.

GetDefault()

public static EnvironmentsSettings GetDefault()

Get a new instance of the default EnvironmentsSettings.

Returns
Type Description
EnvironmentsSettings

A new instance of the default EnvironmentsSettings.