Batch v1 API - Class BatchServiceSettings (2.9.0) 

public sealed class BatchServiceSettings : ServiceSettingsBase

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

Settings for BatchServiceClient instances.

Inheritance

object > ServiceSettingsBase > BatchServiceSettings

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

BatchServiceSettings()

public BatchServiceSettings()

Constructs a new BatchServiceSettings object with default settings.

Properties

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.

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.

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.

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.

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

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.