Class VizierServiceClient

public abstract class VizierServiceClient

VizierService client wrapper, for convenient use.

Inheritance

Object > VizierServiceClient

Derived Types

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

Vertex AI Vizier API.

Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.

Properties

CheckTrialEarlyStoppingStateOperationsClient

public virtual OperationsClient CheckTrialEarlyStoppingStateOperationsClient { get; }

The long-running operations client for CheckTrialEarlyStoppingState.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the VizierService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default VizierService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default VizierService scopes are:

GrpcClient

public virtual VizierService.VizierServiceClient GrpcClient { get; }

The underlying gRPC VizierService client

Property Value
TypeDescription
VizierService.VizierServiceClient

SuggestTrialsOperationsClient

public virtual OperationsClient SuggestTrialsOperationsClient { get; }

The long-running operations client for SuggestTrials.

Property Value
TypeDescription
OperationsClient

Methods

AddTrialMeasurement(AddTrialMeasurementRequest, CallSettings)

public virtual Trial AddTrialMeasurement(AddTrialMeasurementRequest request, CallSettings callSettings = null)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Trial

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
AddTrialMeasurementRequest request = new AddTrialMeasurementRequest
{
    TrialNameAsTrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
    Measurement = new Measurement(),
};
// Make the request
Trial response = vizierServiceClient.AddTrialMeasurement(request);

AddTrialMeasurementAsync(AddTrialMeasurementRequest, CallSettings)

public virtual Task<Trial> AddTrialMeasurementAsync(AddTrialMeasurementRequest request, CallSettings callSettings = null)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
AddTrialMeasurementRequest request = new AddTrialMeasurementRequest
{
    TrialNameAsTrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
    Measurement = new Measurement(),
};
// Make the request
Trial response = await vizierServiceClient.AddTrialMeasurementAsync(request);

AddTrialMeasurementAsync(AddTrialMeasurementRequest, CancellationToken)

public virtual Task<Trial> AddTrialMeasurementAsync(AddTrialMeasurementRequest request, CancellationToken cancellationToken)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
AddTrialMeasurementRequest request = new AddTrialMeasurementRequest
{
    TrialNameAsTrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
    Measurement = new Measurement(),
};
// Make the request
Trial response = await vizierServiceClient.AddTrialMeasurementAsync(request);

CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest, CallSettings)

public virtual Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, CallSettings callSettings = null)

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
CheckTrialEarlyStoppingStateRequest request = new CheckTrialEarlyStoppingStateRequest
{
    TrialNameAsTrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
};
// Make the request
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> response = vizierServiceClient.CheckTrialEarlyStoppingState(request);

// Poll until the returned long-running operation is complete
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
CheckTrialEarlyStoppingStateResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> retrievedResponse = vizierServiceClient.PollOnceCheckTrialEarlyStoppingState(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    CheckTrialEarlyStoppingStateResponse retrievedResult = retrievedResponse.Result;
}

CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CallSettings)

public virtual Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>> CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request, CallSettings callSettings = null)

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CheckTrialEarlyStoppingStateRequest request = new CheckTrialEarlyStoppingStateRequest
{
    TrialNameAsTrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
};
// Make the request
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> response = await vizierServiceClient.CheckTrialEarlyStoppingStateAsync(request);

// Poll until the returned long-running operation is complete
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
CheckTrialEarlyStoppingStateResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> retrievedResponse = await vizierServiceClient.PollOnceCheckTrialEarlyStoppingStateAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    CheckTrialEarlyStoppingStateResponse retrievedResult = retrievedResponse.Result;
}

CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CancellationToken)

public virtual Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>> CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request, CancellationToken cancellationToken)

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CheckTrialEarlyStoppingStateRequest request = new CheckTrialEarlyStoppingStateRequest
{
    TrialNameAsTrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
};
// Make the request
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> response = await vizierServiceClient.CheckTrialEarlyStoppingStateAsync(request);

// Poll until the returned long-running operation is complete
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
CheckTrialEarlyStoppingStateResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> retrievedResponse = await vizierServiceClient.PollOnceCheckTrialEarlyStoppingStateAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    CheckTrialEarlyStoppingStateResponse retrievedResult = retrievedResponse.Result;
}

CompleteTrial(CompleteTrialRequest, CallSettings)

public virtual Trial CompleteTrial(CompleteTrialRequest request, CallSettings callSettings = null)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Trial

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
CompleteTrialRequest request = new CompleteTrialRequest
{
    TrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
    FinalMeasurement = new Measurement(),
    TrialInfeasible = false,
    InfeasibleReason = "",
};
// Make the request
Trial response = vizierServiceClient.CompleteTrial(request);

CompleteTrialAsync(CompleteTrialRequest, CallSettings)

public virtual Task<Trial> CompleteTrialAsync(CompleteTrialRequest request, CallSettings callSettings = null)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CompleteTrialRequest request = new CompleteTrialRequest
{
    TrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
    FinalMeasurement = new Measurement(),
    TrialInfeasible = false,
    InfeasibleReason = "",
};
// Make the request
Trial response = await vizierServiceClient.CompleteTrialAsync(request);

CompleteTrialAsync(CompleteTrialRequest, CancellationToken)

public virtual Task<Trial> CompleteTrialAsync(CompleteTrialRequest request, CancellationToken cancellationToken)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CompleteTrialRequest request = new CompleteTrialRequest
{
    TrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
    FinalMeasurement = new Measurement(),
    TrialInfeasible = false,
    InfeasibleReason = "",
};
// Make the request
Trial response = await vizierServiceClient.CompleteTrialAsync(request);

Create()

public static VizierServiceClient Create()

Synchronously creates a VizierServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use VizierServiceClientBuilder.

Returns
TypeDescription
VizierServiceClient

The created VizierServiceClient.

CreateAsync(CancellationToken)

public static Task<VizierServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a VizierServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use VizierServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<VizierServiceClient>

The task representing the created VizierServiceClient.

CreateStudy(LocationName, Study, CallSettings)

public virtual Study CreateStudy(LocationName parent, Study study, CallSettings callSettings = null)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
parentLocationName

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

studyStudy

Required. The Study configuration used to create the Study.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Study

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Study study = new Study();
// Make the request
Study response = vizierServiceClient.CreateStudy(parent, study);

CreateStudy(CreateStudyRequest, CallSettings)

public virtual Study CreateStudy(CreateStudyRequest request, CallSettings callSettings = null)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
requestCreateStudyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Study

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
CreateStudyRequest request = new CreateStudyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Study = new Study(),
};
// Make the request
Study response = vizierServiceClient.CreateStudy(request);

CreateStudy(String, Study, CallSettings)

public virtual Study CreateStudy(string parent, Study study, CallSettings callSettings = null)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
parentString

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

studyStudy

Required. The Study configuration used to create the Study.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Study

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Study study = new Study();
// Make the request
Study response = vizierServiceClient.CreateStudy(parent, study);

CreateStudyAsync(LocationName, Study, CallSettings)

public virtual Task<Study> CreateStudyAsync(LocationName parent, Study study, CallSettings callSettings = null)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
parentLocationName

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

studyStudy

Required. The Study configuration used to create the Study.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Study>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Study study = new Study();
// Make the request
Study response = await vizierServiceClient.CreateStudyAsync(parent, study);

CreateStudyAsync(LocationName, Study, CancellationToken)

public virtual Task<Study> CreateStudyAsync(LocationName parent, Study study, CancellationToken cancellationToken)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
parentLocationName

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

studyStudy

Required. The Study configuration used to create the Study.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Study>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Study study = new Study();
// Make the request
Study response = await vizierServiceClient.CreateStudyAsync(parent, study);

CreateStudyAsync(CreateStudyRequest, CallSettings)

public virtual Task<Study> CreateStudyAsync(CreateStudyRequest request, CallSettings callSettings = null)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
requestCreateStudyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Study>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CreateStudyRequest request = new CreateStudyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Study = new Study(),
};
// Make the request
Study response = await vizierServiceClient.CreateStudyAsync(request);

CreateStudyAsync(CreateStudyRequest, CancellationToken)

public virtual Task<Study> CreateStudyAsync(CreateStudyRequest request, CancellationToken cancellationToken)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
requestCreateStudyRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Study>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CreateStudyRequest request = new CreateStudyRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Study = new Study(),
};
// Make the request
Study response = await vizierServiceClient.CreateStudyAsync(request);

CreateStudyAsync(String, Study, CallSettings)

public virtual Task<Study> CreateStudyAsync(string parent, Study study, CallSettings callSettings = null)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
parentString

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

studyStudy

Required. The Study configuration used to create the Study.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Study>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Study study = new Study();
// Make the request
Study response = await vizierServiceClient.CreateStudyAsync(parent, study);

CreateStudyAsync(String, Study, CancellationToken)

public virtual Task<Study> CreateStudyAsync(string parent, Study study, CancellationToken cancellationToken)

Creates a Study. A resource name will be generated after creation of the Study.

Parameters
NameDescription
parentString

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

studyStudy

Required. The Study configuration used to create the Study.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Study>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Study study = new Study();
// Make the request
Study response = await vizierServiceClient.CreateStudyAsync(parent, study);

CreateTrial(CreateTrialRequest, CallSettings)

public virtual Trial CreateTrial(CreateTrialRequest request, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Trial

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
CreateTrialRequest request = new CreateTrialRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
    Trial = new Trial(),
};
// Make the request
Trial response = vizierServiceClient.CreateTrial(request);

CreateTrial(StudyName, Trial, CallSettings)

public virtual Trial CreateTrial(StudyName parent, Trial trial, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
NameDescription
parentStudyName

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

trialTrial

Required. The Trial to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Trial

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
StudyName parent = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
Trial trial = new Trial();
// Make the request
Trial response = vizierServiceClient.CreateTrial(parent, trial);

CreateTrial(String, Trial, CallSettings)

public virtual Trial CreateTrial(string parent, Trial trial, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
NameDescription
parentString

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

trialTrial

Required. The Trial to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Trial

The RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
Trial trial = new Trial();
// Make the request
Trial response = vizierServiceClient.CreateTrial(parent, trial);

CreateTrialAsync(CreateTrialRequest, CallSettings)

public virtual Task<Trial> CreateTrialAsync(CreateTrialRequest request, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTrialRequest request = new CreateTrialRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
    Trial = new Trial(),
};
// Make the request
Trial response = await vizierServiceClient.CreateTrialAsync(request);

CreateTrialAsync(CreateTrialRequest, CancellationToken)

public virtual Task<Trial> CreateTrialAsync(CreateTrialRequest request, CancellationToken cancellationToken)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTrialRequest request = new CreateTrialRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
    Trial = new Trial(),
};
// Make the request
Trial response = await vizierServiceClient.CreateTrialAsync(request);

CreateTrialAsync(StudyName, Trial, CallSettings)

public virtual Task<Trial> CreateTrialAsync(StudyName parent, Trial trial, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
NameDescription
parentStudyName

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

trialTrial

Required. The Trial to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
StudyName parent = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
Trial trial = new Trial();
// Make the request
Trial response = await vizierServiceClient.CreateTrialAsync(parent, trial);

CreateTrialAsync(StudyName, Trial, CancellationToken)

public virtual Task<Trial> CreateTrialAsync(StudyName parent, Trial trial, CancellationToken cancellationToken)

Adds a user provided Trial to a Study.

Parameters
NameDescription
parentStudyName

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

trialTrial

Required. The Trial to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
StudyName parent = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
Trial trial = new Trial();
// Make the request
Trial response = await vizierServiceClient.CreateTrialAsync(parent, trial);

CreateTrialAsync(String, Trial, CallSettings)

public virtual Task<Trial> CreateTrialAsync(string parent, Trial trial, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
NameDescription
parentString

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

trialTrial

Required. The Trial to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
Trial trial = new Trial();
// Make the request
Trial response = await vizierServiceClient.CreateTrialAsync(parent, trial);

CreateTrialAsync(String, Trial, CancellationToken)

public virtual Task<Trial> CreateTrialAsync(string parent, Trial trial, CancellationToken cancellationToken)

Adds a user provided Trial to a Study.

Parameters
NameDescription
parentString

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

trialTrial

Required. The Trial to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Trial>

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
Trial trial = new Trial();
// Make the request
Trial response = await vizierServiceClient.CreateTrialAsync(parent, trial);

DeleteStudy(DeleteStudyRequest, CallSettings)

public virtual void DeleteStudy(DeleteStudyRequest request, CallSettings callSettings = null)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
DeleteStudyRequest request = new DeleteStudyRequest
{
    StudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
};
// Make the request
vizierServiceClient.DeleteStudy(request);

DeleteStudy(StudyName, CallSettings)

public virtual void DeleteStudy(StudyName name, CallSettings callSettings = null)

Deletes a Study.

Parameters
NameDescription
nameStudyName

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
StudyName name = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
// Make the request
vizierServiceClient.DeleteStudy(name);

DeleteStudy(String, CallSettings)

public virtual void DeleteStudy(string name, CallSettings callSettings = null)

Deletes a Study.

Parameters
NameDescription
nameString

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
// Make the request
vizierServiceClient.DeleteStudy(name);

DeleteStudyAsync(DeleteStudyRequest, CallSettings)

public virtual Task DeleteStudyAsync(DeleteStudyRequest request, CallSettings callSettings = null)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteStudyRequest request = new DeleteStudyRequest
{
    StudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
};
// Make the request
await vizierServiceClient.DeleteStudyAsync(request);

DeleteStudyAsync(DeleteStudyRequest, CancellationToken)

public virtual Task DeleteStudyAsync(DeleteStudyRequest request, CancellationToken cancellationToken)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteStudyRequest request = new DeleteStudyRequest
{
    StudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
};
// Make the request
await vizierServiceClient.DeleteStudyAsync(request);

DeleteStudyAsync(StudyName, CallSettings)

public virtual Task DeleteStudyAsync(StudyName name, CallSettings callSettings = null)

Deletes a Study.

Parameters
NameDescription
nameStudyName

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
StudyName name = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
// Make the request
await vizierServiceClient.DeleteStudyAsync(name);

DeleteStudyAsync(StudyName, CancellationToken)

public virtual Task DeleteStudyAsync(StudyName name, CancellationToken cancellationToken)

Deletes a Study.

Parameters
NameDescription
nameStudyName

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
StudyName name = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
// Make the request
await vizierServiceClient.DeleteStudyAsync(name);

DeleteStudyAsync(String, CallSettings)

public virtual Task DeleteStudyAsync(string name, CallSettings callSettings = null)

Deletes a Study.

Parameters
NameDescription
nameString

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
// Make the request
await vizierServiceClient.DeleteStudyAsync(name);

DeleteStudyAsync(String, CancellationToken)

public virtual Task DeleteStudyAsync(string name, CancellationToken cancellationToken)

Deletes a Study.

Parameters
NameDescription
nameString

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
// Make the request
await vizierServiceClient.DeleteStudyAsync(name);

DeleteTrial(DeleteTrialRequest, CallSettings)

public virtual void DeleteTrial(DeleteTrialRequest request, CallSettings callSettings = null)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
DeleteTrialRequest request = new DeleteTrialRequest
{
    TrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
};
// Make the request
vizierServiceClient.DeleteTrial(request);

DeleteTrial(TrialName, CallSettings)

public virtual void DeleteTrial(TrialName name, CallSettings callSettings = null)

Deletes a Trial.

Parameters
NameDescription
nameTrialName

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
TrialName name = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]");
// Make the request
vizierServiceClient.DeleteTrial(name);

DeleteTrial(String, CallSettings)

public virtual void DeleteTrial(string name, CallSettings callSettings = null)

Deletes a Trial.

Parameters
NameDescription
nameString

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]/trials/[TRIAL]";
// Make the request
vizierServiceClient.DeleteTrial(name);

DeleteTrialAsync(DeleteTrialRequest, CallSettings)

public virtual Task DeleteTrialAsync(DeleteTrialRequest request, CallSettings callSettings = null)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTrialRequest request = new DeleteTrialRequest
{
    TrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
};
// Make the request
await vizierServiceClient.DeleteTrialAsync(request);

DeleteTrialAsync(DeleteTrialRequest, CancellationToken)

public virtual Task DeleteTrialAsync(DeleteTrialRequest request, CancellationToken cancellationToken)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTrialRequest request = new DeleteTrialRequest
{
    TrialName = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]"),
};
// Make the request
await vizierServiceClient.DeleteTrialAsync(request);

DeleteTrialAsync(TrialName, CallSettings)

public virtual Task DeleteTrialAsync(TrialName name, CallSettings callSettings = null)

Deletes a Trial.

Parameters
NameDescription
nameTrialName

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
TrialName name = TrialName.FromProjectLocationStudyTrial("[PROJECT]", "[LOCATION]", "[STUDY]", "[TRIAL]");
// Make the request
await vizierServiceClient.DeleteTrialAsync(name);

DeleteTrialAsync(TrialName, CancellationToken)

public virtual Task DeleteTrialAsync(TrialName name, CancellationToken cancellationToken)

Deletes a Trial.

Parameters
NameDescription
nameTrialName

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
VizierServiceClient vizierServiceClient = await Vizier