Cloud Functions v1 API - Class CloudFunctionsServiceSettings (2.4.0)

public sealed class CloudFunctionsServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud Functions v1 API class CloudFunctionsServiceSettings.

Settings for CloudFunctionsServiceClient instances.

Inheritance

object > ServiceSettingsBase > CloudFunctionsServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Functions.V1

Assembly

Google.Cloud.Functions.V1.dll

Constructors

CloudFunctionsServiceSettings()

public CloudFunctionsServiceSettings()

Constructs a new CloudFunctionsServiceSettings object with default settings.

Properties

CallFunctionSettings

public CallSettings CallFunctionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.CallFunction and CloudFunctionsServiceClient.CallFunctionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateFunctionOperationsSettings

public OperationsSettings CreateFunctionOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFunctionsServiceClient.CreateFunction and CloudFunctionsServiceClient.CreateFunctionAsync.

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.

CreateFunctionSettings

public CallSettings CreateFunctionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.CreateFunction and CloudFunctionsServiceClient.CreateFunctionAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteFunctionOperationsSettings

public OperationsSettings DeleteFunctionOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFunctionsServiceClient.DeleteFunction and CloudFunctionsServiceClient.DeleteFunctionAsync.

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.

DeleteFunctionSettings

public CallSettings DeleteFunctionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.DeleteFunction and CloudFunctionsServiceClient.DeleteFunctionAsync .

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 600 seconds.

GenerateDownloadUrlSettings

public CallSettings GenerateDownloadUrlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.GenerateDownloadUrl and CloudFunctionsServiceClient.GenerateDownloadUrlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GenerateUploadUrlSettings

public CallSettings GenerateUploadUrlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.GenerateUploadUrl and CloudFunctionsServiceClient.GenerateUploadUrlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetFunctionSettings

public CallSettings GetFunctionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.GetFunction and CloudFunctionsServiceClient.GetFunctionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 600 seconds.

GetIamPolicySettings

public CallSettings GetIamPolicySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.GetIamPolicy and CloudFunctionsServiceClient.GetIamPolicyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

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

Property Value
Type	Description
`IAMPolicySettings`

ListFunctionsSettings

public CallSettings ListFunctionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.ListFunctions and CloudFunctionsServiceClient.ListFunctionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 600 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type	Description
`LocationsSettings`

SetIamPolicySettings

public CallSettings SetIamPolicySettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.SetIamPolicy and CloudFunctionsServiceClient.SetIamPolicyAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

TestIamPermissionsSettings

public CallSettings TestIamPermissionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.TestIamPermissions and CloudFunctionsServiceClient.TestIamPermissionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateFunctionOperationsSettings

public OperationsSettings UpdateFunctionOperationsSettings { get; set; }

Long Running Operation settings for calls to CloudFunctionsServiceClient.UpdateFunction and CloudFunctionsServiceClient.UpdateFunctionAsync.

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.

UpdateFunctionSettings

public CallSettings UpdateFunctionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to CloudFunctionsServiceClient.UpdateFunction and CloudFunctionsServiceClient.UpdateFunctionAsync .

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 600 seconds.

Methods

Clone()

public CloudFunctionsServiceSettings Clone()

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

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

GetDefault()

public static CloudFunctionsServiceSettings GetDefault()

Get a new instance of the default CloudFunctionsServiceSettings.

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