Cloud AI Platform v1beta1 API - Class VizierServiceSettings (1.0.0-beta08)

Version 1.0.0-beta08

• 1.0.0-beta12 (latest)
• 1.0.0-beta11

public sealed class VizierServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class VizierServiceSettings.

Settings for VizierServiceClient instances.

Inheritance

object > ServiceSettingsBase > VizierServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

VizierServiceSettings()

public VizierServiceSettings()

Constructs a new VizierServiceSettings object with default settings.

Properties

AddTrialMeasurementSettings

public CallSettings AddTrialMeasurementSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.AddTrialMeasurement and VizierServiceClient.AddTrialMeasurementAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

CheckTrialEarlyStoppingStateOperationsSettings

public OperationsSettings CheckTrialEarlyStoppingStateOperationsSettings { get; set; }

Long Running Operation settings for calls to VizierServiceClient.CheckTrialEarlyStoppingState and VizierServiceClient.CheckTrialEarlyStoppingStateAsync.

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.

CheckTrialEarlyStoppingStateSettings

public CallSettings CheckTrialEarlyStoppingStateSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.CheckTrialEarlyStoppingState and VizierServiceClient.CheckTrialEarlyStoppingStateAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

CompleteTrialSettings

public CallSettings CompleteTrialSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.CompleteTrial and VizierServiceClient.CompleteTrialAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

CreateStudySettings

public CallSettings CreateStudySettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.CreateStudy and VizierServiceClient.CreateStudyAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

CreateTrialSettings

public CallSettings CreateTrialSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.CreateTrial and VizierServiceClient.CreateTrialAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

DeleteStudySettings

public CallSettings DeleteStudySettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.DeleteStudy and VizierServiceClient.DeleteStudyAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

DeleteTrialSettings

public CallSettings DeleteTrialSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.DeleteTrial and VizierServiceClient.DeleteTrialAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

GetStudySettings

public CallSettings GetStudySettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.GetStudy and VizierServiceClient.GetStudyAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

GetTrialSettings

public CallSettings GetTrialSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.GetTrial and VizierServiceClient.GetTrialAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

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

Property Value
Type	Description
IAMPolicySettings

ListOptimalTrialsSettings

public CallSettings ListOptimalTrialsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.ListOptimalTrials and VizierServiceClient.ListOptimalTrialsAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

ListStudiesSettings

public CallSettings ListStudiesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.ListStudies and VizierServiceClient.ListStudiesAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

ListTrialsSettings

public CallSettings ListTrialsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.ListTrials and VizierServiceClient.ListTrialsAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type	Description
LocationsSettings

LookupStudySettings

public CallSettings LookupStudySettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.LookupStudy and VizierServiceClient.LookupStudyAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

StopTrialSettings

public CallSettings StopTrialSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.StopTrial and VizierServiceClient.StopTrialAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

SuggestTrialsOperationsSettings

public OperationsSettings SuggestTrialsOperationsSettings { get; set; }

Long Running Operation settings for calls to VizierServiceClient.SuggestTrials and VizierServiceClient.SuggestTrialsAsync.

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.

SuggestTrialsSettings

public CallSettings SuggestTrialsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VizierServiceClient.SuggestTrials and VizierServiceClient.SuggestTrialsAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 5 seconds.

Methods

Clone()

public VizierServiceSettings Clone()

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

Returns
Type	Description
VizierServiceSettings	A deep clone of this VizierServiceSettings object.

GetDefault()

public static VizierServiceSettings GetDefault()

Get a new instance of the default VizierServiceSettings.

Returns
Type	Description
VizierServiceSettings	A new instance of the default VizierServiceSettings.