Class ProjectsResource.LocationsResource.HyperparameterTuningJobsResource

The "hyperparameterTuningJobs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.HyperparameterTuningJobsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class ProjectsResource.LocationsResource.HyperparameterTuningJobsResource

Constructors

HyperparameterTuningJobsResource(IClientService)

Constructs a new resource.

Declaration

public HyperparameterTuningJobsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource

Methods

Cancel(GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest, string)

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

Declaration

public virtual ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.CancelRequest Cancel(GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest	body	The body of the request.
string	name	Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns

Type	Description
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.CancelRequest

Create(GoogleCloudAiplatformV1HyperparameterTuningJob, string)

Creates a HyperparameterTuningJob

Declaration

public virtual ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.CreateRequest Create(GoogleCloudAiplatformV1HyperparameterTuningJob body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1HyperparameterTuningJob	body	The body of the request.
string	parent	Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.CreateRequest

Delete(string)

Deletes a HyperparameterTuningJob.

Declaration

public virtual ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns

Type	Description
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.DeleteRequest

Get(string)

Gets a HyperparameterTuningJob

Declaration

public virtual ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the HyperparameterTuningJob resource. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns

Type	Description
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.GetRequest

List(string)

Lists HyperparameterTuningJobs in a Location.

Declaration

public virtual ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.ListRequest