Batch v1alpha API - Class BatchServiceSettings (1.0.0-alpha31)

public sealed class BatchServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Batch v1alpha API class BatchServiceSettings.

Settings for BatchServiceClient instances.

Inheritance

object > ServiceSettingsBase > BatchServiceSettings

Namespace

Google.Cloud.Batch.V1Alpha

Assembly

Google.Cloud.Batch.V1Alpha.dll

Constructors

BatchServiceSettings()

public BatchServiceSettings()

Constructs a new BatchServiceSettings object with default settings.

Properties

CancelJobOperationsSettings

public OperationsSettings CancelJobOperationsSettings { get; set; }

Long Running Operation settings for calls to BatchServiceClient.CancelJob and BatchServiceClient.CancelJobAsync.

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.

CancelJobSettings

public CallSettings CancelJobSettings { get; set; }

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

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

CreateJobSettings

public CallSettings CreateJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.CreateJob and BatchServiceClient.CreateJobAsync.

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

CreateResourceAllowanceSettings

public CallSettings CreateResourceAllowanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.CreateResourceAllowance and BatchServiceClient.CreateResourceAllowanceAsync .

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

DeleteJobOperationsSettings

public OperationsSettings DeleteJobOperationsSettings { get; set; }

Long Running Operation settings for calls to BatchServiceClient.DeleteJob and BatchServiceClient.DeleteJobAsync.

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.

DeleteJobSettings

public CallSettings DeleteJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.DeleteJob and BatchServiceClient.DeleteJobAsync.

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

DeleteResourceAllowanceOperationsSettings

public OperationsSettings DeleteResourceAllowanceOperationsSettings { get; set; }

Long Running Operation settings for calls to BatchServiceClient.DeleteResourceAllowance and BatchServiceClient.DeleteResourceAllowanceAsync.

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.

DeleteResourceAllowanceSettings

public CallSettings DeleteResourceAllowanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.DeleteResourceAllowance and BatchServiceClient.DeleteResourceAllowanceAsync .

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

GetJobSettings

public CallSettings GetJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.GetJob and BatchServiceClient.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.

GetResourceAllowanceSettings

public CallSettings GetResourceAllowanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.GetResourceAllowance and BatchServiceClient.GetResourceAllowanceAsync.

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 BatchServiceClient.GetTask and BatchServiceClient.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.

ListJobsSettings

public CallSettings ListJobsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.ListJobs and BatchServiceClient.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.

ListResourceAllowancesSettings

public CallSettings ListResourceAllowancesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.ListResourceAllowances and BatchServiceClient.ListResourceAllowancesAsync.

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.

ListTasksSettings

public CallSettings ListTasksSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.ListTasks and BatchServiceClient.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.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type Description
LocationsSettings

UpdateJobSettings

public CallSettings UpdateJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.UpdateJob and BatchServiceClient.UpdateJobAsync.

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

UpdateResourceAllowanceSettings

public CallSettings UpdateResourceAllowanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to BatchServiceClient.UpdateResourceAllowance and BatchServiceClient.UpdateResourceAllowanceAsync .

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

Methods

Clone()

public BatchServiceSettings Clone()

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

Returns
Type Description
BatchServiceSettings

A deep clone of this BatchServiceSettings object.

GetDefault()

public static BatchServiceSettings GetDefault()

Get a new instance of the default BatchServiceSettings.

Returns
Type Description
BatchServiceSettings

A new instance of the default BatchServiceSettings.