DataStream v1 API - Class DatastreamSettings (2.3.0)

public sealed class DatastreamSettings : ServiceSettingsBase

Reference documentation and code samples for the DataStream v1 API class DatastreamSettings.

Settings for DatastreamClient instances.

Inheritance

object > ServiceSettingsBase > DatastreamSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

DatastreamSettings()

public DatastreamSettings()

Constructs a new DatastreamSettings object with default settings.

Properties

CreateConnectionProfileOperationsSettings

public OperationsSettings CreateConnectionProfileOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.CreateConnectionProfile and DatastreamClient.CreateConnectionProfileAsync.

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.

CreateConnectionProfileSettings

public CallSettings CreateConnectionProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.CreateConnectionProfile and DatastreamClient.CreateConnectionProfileAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreatePrivateConnectionOperationsSettings

public OperationsSettings CreatePrivateConnectionOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.CreatePrivateConnection and DatastreamClient.CreatePrivateConnectionAsync.

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.

CreatePrivateConnectionSettings

public CallSettings CreatePrivateConnectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.CreatePrivateConnection and DatastreamClient.CreatePrivateConnectionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateRouteOperationsSettings

public OperationsSettings CreateRouteOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.CreateRoute and DatastreamClient.CreateRouteAsync.

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.

CreateRouteSettings

public CallSettings CreateRouteSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.CreateRoute and DatastreamClient.CreateRouteAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateStreamOperationsSettings

public OperationsSettings CreateStreamOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.CreateStream and DatastreamClient.CreateStreamAsync.

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.

CreateStreamSettings

public CallSettings CreateStreamSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.CreateStream and DatastreamClient.CreateStreamAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteConnectionProfileOperationsSettings

public OperationsSettings DeleteConnectionProfileOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.DeleteConnectionProfile and DatastreamClient.DeleteConnectionProfileAsync.

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.

DeleteConnectionProfileSettings

public CallSettings DeleteConnectionProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.DeleteConnectionProfile and DatastreamClient.DeleteConnectionProfileAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeletePrivateConnectionOperationsSettings

public OperationsSettings DeletePrivateConnectionOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.DeletePrivateConnection and DatastreamClient.DeletePrivateConnectionAsync.

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.

DeletePrivateConnectionSettings

public CallSettings DeletePrivateConnectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.DeletePrivateConnection and DatastreamClient.DeletePrivateConnectionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteRouteOperationsSettings

public OperationsSettings DeleteRouteOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.DeleteRoute and DatastreamClient.DeleteRouteAsync.

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.

DeleteRouteSettings

public CallSettings DeleteRouteSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.DeleteRoute and DatastreamClient.DeleteRouteAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteStreamOperationsSettings

public OperationsSettings DeleteStreamOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.DeleteStream and DatastreamClient.DeleteStreamAsync.

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.

DeleteStreamSettings

public CallSettings DeleteStreamSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.DeleteStream and DatastreamClient.DeleteStreamAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DiscoverConnectionProfileSettings

public CallSettings DiscoverConnectionProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.DiscoverConnectionProfile and DatastreamClient.DiscoverConnectionProfileAsync .

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.

FetchStaticIpsSettings

public CallSettings FetchStaticIpsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.FetchStaticIps and DatastreamClient.FetchStaticIpsAsync.

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.

GetConnectionProfileSettings

public CallSettings GetConnectionProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.GetConnectionProfile and DatastreamClient.GetConnectionProfileAsync.

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.

GetPrivateConnectionSettings

public CallSettings GetPrivateConnectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.GetPrivateConnection and DatastreamClient.GetPrivateConnectionAsync.

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.

GetRouteSettings

public CallSettings GetRouteSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.GetRoute and DatastreamClient.GetRouteAsync.

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.

GetStreamObjectSettings

public CallSettings GetStreamObjectSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.GetStreamObject and DatastreamClient.GetStreamObjectAsync.

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.

GetStreamSettings

public CallSettings GetStreamSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.GetStream and DatastreamClient.GetStreamAsync.

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`

ListConnectionProfilesSettings

public CallSettings ListConnectionProfilesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.ListConnectionProfiles and DatastreamClient.ListConnectionProfilesAsync.

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.

ListPrivateConnectionsSettings

public CallSettings ListPrivateConnectionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.ListPrivateConnections and DatastreamClient.ListPrivateConnectionsAsync.

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.

ListRoutesSettings

public CallSettings ListRoutesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.ListRoutes and DatastreamClient.ListRoutesAsync.

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.

ListStreamObjectsSettings

public CallSettings ListStreamObjectsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.ListStreamObjects and DatastreamClient.ListStreamObjectsAsync.

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.

ListStreamsSettings

public CallSettings ListStreamsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.ListStreams and DatastreamClient.ListStreamsAsync.

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`

LookupStreamObjectSettings

public CallSettings LookupStreamObjectSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.LookupStreamObject and DatastreamClient.LookupStreamObjectAsync.

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.

StartBackfillJobSettings

public CallSettings StartBackfillJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.StartBackfillJob and DatastreamClient.StartBackfillJobAsync.

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.

StopBackfillJobSettings

public CallSettings StopBackfillJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.StopBackfillJob and DatastreamClient.StopBackfillJobAsync.

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.

UpdateConnectionProfileOperationsSettings

public OperationsSettings UpdateConnectionProfileOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.UpdateConnectionProfile and DatastreamClient.UpdateConnectionProfileAsync.

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.

UpdateConnectionProfileSettings

public CallSettings UpdateConnectionProfileSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.UpdateConnectionProfile and DatastreamClient.UpdateConnectionProfileAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateStreamOperationsSettings

public OperationsSettings UpdateStreamOperationsSettings { get; set; }

Long Running Operation settings for calls to DatastreamClient.UpdateStream and DatastreamClient.UpdateStreamAsync.

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.

UpdateStreamSettings

public CallSettings UpdateStreamSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DatastreamClient.UpdateStream and DatastreamClient.UpdateStreamAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

Methods

Clone()

public DatastreamSettings Clone()

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

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

GetDefault()

public static DatastreamSettings GetDefault()

Get a new instance of the default DatastreamSettings.

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