Cloud AI Platform v1beta1 API - Class VizierServiceClient (1.0.0-beta06)

Version 1.0.0-beta06

• 1.0.0-beta12 (latest)
• 1.0.0-beta11

public abstract class VizierServiceClient

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

VizierService client wrapper, for convenient use.

Inheritance

object > VizierServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

VizierServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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
Type	Description
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
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default VizierService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default VizierService scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual VizierService.VizierServiceClient GrpcClient { get; }

The underlying gRPC VizierService client

Property Value
Type	Description
VizierServiceVizierServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

SuggestTrialsOperationsClient

public virtual OperationsClient SuggestTrialsOperationsClient { get; }

The long-running operations client for SuggestTrials.

Property Value
Type	Description
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
Name	Description
request	AddTrialMeasurementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
request	AddTrialMeasurementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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
Name	Description
request	AddTrialMeasurementRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].

Parameters
Name	Description
request	CheckTrialEarlyStoppingStateRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata	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.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].

Parameters
Name	Description
request	CheckTrialEarlyStoppingStateRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata	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.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].

Parameters
Name	Description
request	CheckTrialEarlyStoppingStateRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata	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
Name	Description
request	CompleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
request	CompleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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
Name	Description
request	CompleteTrialRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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
Type	Description
VizierServiceClient	The created VizierServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskVizierServiceClient	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
Name	Description
parent	LocationName Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
study	Study Required. The Study configuration used to create the Study.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
request	CreateStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
parent	string Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
study	Study Required. The Study configuration used to create the Study.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
parent	LocationName Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
study	Study Required. The Study configuration used to create the Study.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	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
Name	Description
parent	LocationName Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
study	Study Required. The Study configuration used to create the Study.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	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
Name	Description
request	CreateStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	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
Name	Description
request	CreateStudyRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	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
Name	Description
parent	string Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
study	Study Required. The Study configuration used to create the Study.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	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
Name	Description
parent	string Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}
study	Study Required. The Study configuration used to create the Study.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	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
Name	Description
request	CreateTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
parent	StudyName Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}
trial	Trial Required. The Trial to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
parent	string Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}
trial	Trial Required. The Trial to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
request	CreateTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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
Name	Description
request	CreateTrialRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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
Name	Description
parent	StudyName Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}
trial	Trial Required. The Trial to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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
Name	Description
parent	StudyName Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}
trial	Trial Required. The Trial to create.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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
Name	Description
parent	string Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}
trial	Trial Required. The Trial to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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
Name	Description
parent	string Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}
trial	Trial Required. The Trial to create.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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
Name	Description
request	DeleteStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings 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
Name	Description
name	StudyName Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings 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
Name	Description
name	string Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings 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
Name	Description
request	DeleteStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
request	DeleteStudyRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
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
Name	Description
name	StudyName Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
name	StudyName Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
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
Name	Description
name	string Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
name	string Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
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
Name	Description
request	DeleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings 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
Name	Description
name	TrialName Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings 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
Name	Description
name	string Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings 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
Name	Description
request	DeleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
request	DeleteTrialRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
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
Name	Description
name	TrialName Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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
Name	Description
name	TrialName Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
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(string, CallSettings)

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

Deletes a Trial.

Parameters
Name	Description
name	string Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
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]/trials/[TRIAL]";
// Make the request
await vizierServiceClient.DeleteTrialAsync(name);

DeleteTrialAsync(string, CancellationToken)

public virtual Task DeleteTrialAsync(string name, CancellationToken cancellationToken)

Deletes a Trial.

Parameters
Name	Description
name	string Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
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]/trials/[TRIAL]";
// Make the request
await vizierServiceClient.DeleteTrialAsync(name);

GetStudy(GetStudyRequest, CallSettings)

public virtual Study GetStudy(GetStudyRequest request, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
request	GetStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Example

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

GetStudy(StudyName, CallSettings)

public virtual Study GetStudy(StudyName name, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
name	StudyName Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Example

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

GetStudy(string, CallSettings)

public virtual Study GetStudy(string name, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
name	string Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Example

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

GetStudyAsync(GetStudyRequest, CallSettings)

public virtual Task<Study> GetStudyAsync(GetStudyRequest request, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
request	GetStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

GetStudyAsync(GetStudyRequest, CancellationToken)

public virtual Task<Study> GetStudyAsync(GetStudyRequest request, CancellationToken cancellationToken)

Gets a Study by name.

Parameters
Name	Description
request	GetStudyRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

GetStudyAsync(StudyName, CallSettings)

public virtual Task<Study> GetStudyAsync(StudyName name, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
name	StudyName Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	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
Study response = await vizierServiceClient.GetStudyAsync(name);

GetStudyAsync(StudyName, CancellationToken)

public virtual Task<Study> GetStudyAsync(StudyName name, CancellationToken cancellationToken)

Gets a Study by name.

Parameters
Name	Description
name	StudyName Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	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
Study response = await vizierServiceClient.GetStudyAsync(name);

GetStudyAsync(string, CallSettings)

public virtual Task<Study> GetStudyAsync(string name, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
name	string Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	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
Study response = await vizierServiceClient.GetStudyAsync(name);

GetStudyAsync(string, CancellationToken)

public virtual Task<Study> GetStudyAsync(string name, CancellationToken cancellationToken)

Gets a Study by name.

Parameters
Name	Description
name	string Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	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
Study response = await vizierServiceClient.GetStudyAsync(name);

GetTrial(GetTrialRequest, CallSettings)

public virtual Trial GetTrial(GetTrialRequest request, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
request	GetTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Example

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

GetTrial(TrialName, CallSettings)

public virtual Trial GetTrial(TrialName name, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
name	TrialName Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Example

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

GetTrial(string, CallSettings)

public virtual Trial GetTrial(string name, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
name	string Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Example

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

GetTrialAsync(GetTrialRequest, CallSettings)

public virtual Task<Trial> GetTrialAsync(GetTrialRequest request, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
request	GetTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	A Task containing the RPC response.

Example

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

GetTrialAsync(GetTrialRequest, CancellationToken)

public virtual Task<Trial> GetTrialAsync(GetTrialRequest request, CancellationToken cancellationToken)

Gets a Trial.

Parameters
Name	Description
request	GetTrialRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	A Task containing the RPC response.

Example

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

GetTrialAsync(TrialName, CallSettings)

public virtual Task<Trial> GetTrialAsync(TrialName name, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
name	TrialName Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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
Trial response = await vizierServiceClient.GetTrialAsync(name);

GetTrialAsync(TrialName, CancellationToken)

public virtual Task<Trial> GetTrialAsync(TrialName name, CancellationToken cancellationToken)

Gets a Trial.

Parameters
Name	Description
name	TrialName Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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
Trial response = await vizierServiceClient.GetTrialAsync(name);

GetTrialAsync(string, CallSettings)

public virtual Task<Trial> GetTrialAsync(string name, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
name	string Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	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]/trials/[TRIAL]";
// Make the request
Trial response = await vizierServiceClient.GetTrialAsync(name);

GetTrialAsync(string, CancellationToken)

public virtual Task<Trial> GetTrialAsync(string name, CancellationToken cancellationToken)

Gets a Trial.

Parameters
Name	Description
name	string Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	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]/trials/[TRIAL]";
// Make the request
Trial response = await vizierServiceClient.GetTrialAsync(name);

ListOptimalTrials(ListOptimalTrialsRequest, CallSettings)

public virtual ListOptimalTrialsResponse ListOptimalTrials(ListOptimalTrialsRequest request, CallSettings callSettings = null)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
request	ListOptimalTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ListOptimalTrialsResponse	The RPC response.

Example

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

ListOptimalTrials(StudyName, CallSettings)

public virtual ListOptimalTrialsResponse ListOptimalTrials(StudyName parent, CallSettings callSettings = null)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
parent	StudyName Required. The name of the Study that the optimal Trial belongs to.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ListOptimalTrialsResponse	The RPC response.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
StudyName parent = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
// Make the request
ListOptimalTrialsResponse response = vizierServiceClient.ListOptimalTrials(parent);

ListOptimalTrials(string, CallSettings)

public virtual ListOptimalTrialsResponse ListOptimalTrials(string parent, CallSettings callSettings = null)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
parent	string Required. The name of the Study that the optimal Trial belongs to.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ListOptimalTrialsResponse	The RPC response.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
// Make the request
ListOptimalTrialsResponse response = vizierServiceClient.ListOptimalTrials(parent);

ListOptimalTrialsAsync(ListOptimalTrialsRequest, CallSettings)

public virtual Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(ListOptimalTrialsRequest request, CallSettings callSettings = null)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
request	ListOptimalTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskListOptimalTrialsResponse	A Task containing the RPC response.

Example

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

ListOptimalTrialsAsync(ListOptimalTrialsRequest, CancellationToken)

public virtual Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(ListOptimalTrialsRequest request, CancellationToken cancellationToken)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
request	ListOptimalTrialsRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskListOptimalTrialsResponse	A Task containing the RPC response.

Example

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

ListOptimalTrialsAsync(StudyName, CallSettings)

public virtual Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(StudyName parent, CallSettings callSettings = null)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
parent	StudyName Required. The name of the Study that the optimal Trial belongs to.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskListOptimalTrialsResponse	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]");
// Make the request
ListOptimalTrialsResponse response = await vizierServiceClient.ListOptimalTrialsAsync(parent);

ListOptimalTrialsAsync(StudyName, CancellationToken)

public virtual Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(StudyName parent, CancellationToken cancellationToken)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
parent	StudyName Required. The name of the Study that the optimal Trial belongs to.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskListOptimalTrialsResponse	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]");
// Make the request
ListOptimalTrialsResponse response = await vizierServiceClient.ListOptimalTrialsAsync(parent);

ListOptimalTrialsAsync(string, CallSettings)

public virtual Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(string parent, CallSettings callSettings = null)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
parent	string Required. The name of the Study that the optimal Trial belongs to.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskListOptimalTrialsResponse	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]";
// Make the request
ListOptimalTrialsResponse response = await vizierServiceClient.ListOptimalTrialsAsync(parent);

ListOptimalTrialsAsync(string, CancellationToken)

public virtual Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(string parent, CancellationToken cancellationToken)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters
Name	Description
parent	string Required. The name of the Study that the optimal Trial belongs to.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskListOptimalTrialsResponse	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]";
// Make the request
ListOptimalTrialsResponse response = await vizierServiceClient.ListOptimalTrialsAsync(parent);

ListStudies(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListStudiesResponse, Study> ListStudies(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the studies in a region for an associated project.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListStudiesResponseStudy	A pageable sequence of Study resources.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListStudiesResponse, Study> response = vizierServiceClient.ListStudies(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Study item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListStudiesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Study item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Study> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Study item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListStudies(ListStudiesRequest, CallSettings)

public virtual PagedEnumerable<ListStudiesResponse, Study> ListStudies(ListStudiesRequest request, CallSettings callSettings = null)

Lists all the studies in a region for an associated project.

Parameters
Name	Description
request	ListStudiesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListStudiesResponseStudy	A pageable sequence of Study resources.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
ListStudiesRequest request = new ListStudiesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListStudiesResponse, Study> response = vizierServiceClient.ListStudies(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Study item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListStudiesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Study item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Study> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Study item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListStudies(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListStudiesResponse, Study> ListStudies(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the studies in a region for an associated project.

Parameters
Name	Description
parent	string Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListStudiesResponseStudy	A pageable sequence of Study resources.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListStudiesResponse, Study> response = vizierServiceClient.ListStudies(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Study item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListStudiesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Study item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Study> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Study item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListStudiesAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListStudiesResponse, Study> ListStudiesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the studies in a region for an associated project.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListStudiesResponseStudy	A pageable asynchronous sequence of Study resources.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListStudiesResponse, Study> response = vizierServiceClient.ListStudiesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Study item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListStudiesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Study item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Study> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Study item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListStudiesAsync(ListStudiesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListStudiesResponse, Study> ListStudiesAsync(ListStudiesRequest request, CallSettings callSettings = null)

Lists all the studies in a region for an associated project.

Parameters
Name	Description
request	ListStudiesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListStudiesResponseStudy	A pageable asynchronous sequence of Study resources.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
ListStudiesRequest request = new ListStudiesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListStudiesResponse, Study> response = vizierServiceClient.ListStudiesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Study item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListStudiesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Study item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Study> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Study item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListStudiesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListStudiesResponse, Study> ListStudiesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all the studies in a region for an associated project.

Parameters
Name	Description
parent	string Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListStudiesResponseStudy	A pageable asynchronous sequence of Study resources.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListStudiesResponse, Study> response = vizierServiceClient.ListStudiesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Study item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListStudiesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Study item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Study> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Study item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTrials(ListTrialsRequest, CallSettings)

public virtual PagedEnumerable<ListTrialsResponse, Trial> ListTrials(ListTrialsRequest request, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
request	ListTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListTrialsResponseTrial	A pageable sequence of Trial resources.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
ListTrialsRequest request = new ListTrialsRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
};
// Make the request
PagedEnumerable<ListTrialsResponse, Trial> response = vizierServiceClient.ListTrials(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Trial item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTrialsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Trial item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Trial> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Trial item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTrials(StudyName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTrialsResponse, Trial> ListTrials(StudyName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
parent	StudyName Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListTrialsResponseTrial	A pageable sequence of Trial resources.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
StudyName parent = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
// Make the request
PagedEnumerable<ListTrialsResponse, Trial> response = vizierServiceClient.ListTrials(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Trial item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTrialsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Trial item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Trial> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Trial item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTrials(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTrialsResponse, Trial> ListTrials(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
parent	string Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListTrialsResponseTrial	A pageable sequence of Trial resources.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
// Make the request
PagedEnumerable<ListTrialsResponse, Trial> response = vizierServiceClient.ListTrials(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Trial item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTrialsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Trial item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Trial> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Trial item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTrialsAsync(ListTrialsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTrialsResponse, Trial> ListTrialsAsync(ListTrialsRequest request, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
request	ListTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListTrialsResponseTrial	A pageable asynchronous sequence of Trial resources.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
ListTrialsRequest request = new ListTrialsRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
};
// Make the request
PagedAsyncEnumerable<ListTrialsResponse, Trial> response = vizierServiceClient.ListTrialsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Trial item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTrialsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Trial item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Trial> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Trial item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTrialsAsync(StudyName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTrialsResponse, Trial> ListTrialsAsync(StudyName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
parent	StudyName Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListTrialsResponseTrial	A pageable asynchronous sequence of Trial resources.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
StudyName parent = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]");
// Make the request
PagedAsyncEnumerable<ListTrialsResponse, Trial> response = vizierServiceClient.ListTrialsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Trial item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTrialsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Trial item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Trial> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Trial item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTrialsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTrialsResponse, Trial> ListTrialsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
parent	string Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListTrialsResponseTrial	A pageable asynchronous sequence of Trial resources.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/studies/[STUDY]";
// Make the request
PagedAsyncEnumerable<ListTrialsResponse, Trial> response = vizierServiceClient.ListTrialsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Trial item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTrialsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Trial item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Trial> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Trial item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

LookupStudy(LocationName, CallSettings)

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

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Example

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

LookupStudy(LookupStudyRequest, CallSettings)

public virtual Study LookupStudy(LookupStudyRequest request, CallSettings callSettings = null)

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
request	LookupStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Example

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

LookupStudy(string, CallSettings)

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

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
parent	string Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Example

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

LookupStudyAsync(LocationName, CallSettings)

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

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

LookupStudyAsync(LocationName, CancellationToken)

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

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

LookupStudyAsync(LookupStudyRequest, CallSettings)

public virtual Task<Study> LookupStudyAsync(LookupStudyRequest request, CallSettings callSettings = null)

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
request	LookupStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

LookupStudyAsync(LookupStudyRequest, CancellationToken)

public virtual Task<Study> LookupStudyAsync(LookupStudyRequest request, CancellationToken cancellationToken)

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
request	LookupStudyRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

LookupStudyAsync(string, CallSettings)

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

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
parent	string Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

LookupStudyAsync(string, CancellationToken)

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

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters
Name	Description
parent	string Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskStudy	A Task containing the RPC response.

Example

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

PollOnceCheckTrialEarlyStoppingState(string, CallSettings)

public virtual Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> PollOnceCheckTrialEarlyStoppingState(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CheckTrialEarlyStoppingState.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata	The result of polling the operation.

PollOnceCheckTrialEarlyStoppingStateAsync(string, CallSettings)

public virtual Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>> PollOnceCheckTrialEarlyStoppingStateAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CheckTrialEarlyStoppingState.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata	A task representing the result of polling the operation.

PollOnceSuggestTrials(string, CallSettings)

public virtual Operation<SuggestTrialsResponse, SuggestTrialsMetadata> PollOnceSuggestTrials(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SuggestTrials.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationSuggestTrialsResponseSuggestTrialsMetadata	The result of polling the operation.

PollOnceSuggestTrialsAsync(string, CallSettings)

public virtual Task<Operation<SuggestTrialsResponse, SuggestTrialsMetadata>> PollOnceSuggestTrialsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SuggestTrials.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationSuggestTrialsResponseSuggestTrialsMetadata	A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StopTrial(StopTrialRequest, CallSettings)

public virtual Trial StopTrial(StopTrialRequest request, CallSettings callSettings = null)

Stops a Trial.

Parameters
Name	Description
request	StopTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Example

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

StopTrialAsync(StopTrialRequest, CallSettings)

public virtual Task<Trial> StopTrialAsync(StopTrialRequest request, CallSettings callSettings = null)

Stops a Trial.

Parameters
Name	Description
request	StopTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTrial	A Task containing the RPC response.

Example

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

StopTrialAsync(StopTrialRequest, CancellationToken)

public virtual Task<Trial> StopTrialAsync(StopTrialRequest request, CancellationToken cancellationToken)

Stops a Trial.

Parameters
Name	Description
request	StopTrialRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTrial	A Task containing the RPC response.

Example

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

SuggestTrials(SuggestTrialsRequest, CallSettings)

public virtual Operation<SuggestTrialsResponse, SuggestTrialsMetadata> SuggestTrials(SuggestTrialsRequest request, CallSettings callSettings = null)

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1beta1.SuggestTrialsResponse].

Parameters
Name	Description
request	SuggestTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationSuggestTrialsResponseSuggestTrialsMetadata	The RPC response.

Example

// Create client
VizierServiceClient vizierServiceClient = VizierServiceClient.Create();
// Initialize request argument(s)
SuggestTrialsRequest request = new SuggestTrialsRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
    SuggestionCount = 0,
    ClientId = "",
    Contexts = { new TrialContext(), },
};
// Make the request
Operation<SuggestTrialsResponse, SuggestTrialsMetadata> response = vizierServiceClient.SuggestTrials(request);

// Poll until the returned long-running operation is complete
Operation<SuggestTrialsResponse, SuggestTrialsMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SuggestTrialsResponse 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<SuggestTrialsResponse, SuggestTrialsMetadata> retrievedResponse = vizierServiceClient.PollOnceSuggestTrials(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SuggestTrialsResponse retrievedResult = retrievedResponse.Result;
}

SuggestTrialsAsync(SuggestTrialsRequest, CallSettings)

public virtual Task<Operation<SuggestTrialsResponse, SuggestTrialsMetadata>> SuggestTrialsAsync(SuggestTrialsRequest request, CallSettings callSettings = null)

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1beta1.SuggestTrialsResponse].

Parameters
Name	Description
request	SuggestTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationSuggestTrialsResponseSuggestTrialsMetadata	A Task containing the RPC response.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
SuggestTrialsRequest request = new SuggestTrialsRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
    SuggestionCount = 0,
    ClientId = "",
    Contexts = { new TrialContext(), },
};
// Make the request
Operation<SuggestTrialsResponse, SuggestTrialsMetadata> response = await vizierServiceClient.SuggestTrialsAsync(request);

// Poll until the returned long-running operation is complete
Operation<SuggestTrialsResponse, SuggestTrialsMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SuggestTrialsResponse 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<SuggestTrialsResponse, SuggestTrialsMetadata> retrievedResponse = await vizierServiceClient.PollOnceSuggestTrialsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SuggestTrialsResponse retrievedResult = retrievedResponse.Result;
}

SuggestTrialsAsync(SuggestTrialsRequest, CancellationToken)

public virtual Task<Operation<SuggestTrialsResponse, SuggestTrialsMetadata>> SuggestTrialsAsync(SuggestTrialsRequest request, CancellationToken cancellationToken)

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1beta1.SuggestTrialsResponse].

Parameters
Name	Description
request	SuggestTrialsRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationSuggestTrialsResponseSuggestTrialsMetadata	A Task containing the RPC response.

Example

// Create client
VizierServiceClient vizierServiceClient = await VizierServiceClient.CreateAsync();
// Initialize request argument(s)
SuggestTrialsRequest request = new SuggestTrialsRequest
{
    ParentAsStudyName = StudyName.FromProjectLocationStudy("[PROJECT]", "[LOCATION]", "[STUDY]"),
    SuggestionCount = 0,
    ClientId = "",
    Contexts = { new TrialContext(), },
};
// Make the request
Operation<SuggestTrialsResponse, SuggestTrialsMetadata> response = await vizierServiceClient.SuggestTrialsAsync(request);

// Poll until the returned long-running operation is complete
Operation<SuggestTrialsResponse, SuggestTrialsMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SuggestTrialsResponse 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<SuggestTrialsResponse, SuggestTrialsMetadata> retrievedResponse = await vizierServiceClient.PollOnceSuggestTrialsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SuggestTrialsResponse retrievedResult = retrievedResponse.Result;
}