Class ProjectsResource.LocationsResource.CustomJobsResource
The "customJobs" collection of methods.
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.CustomJobsResource
Constructors
CustomJobsResource(IClientService)
Constructs a new resource.
Declaration
public CustomJobsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Operations
Gets the Operations resource.
Declaration
public virtual ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource Operations { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource |
Methods
Cancel(GoogleCloudAiplatformV1beta1CancelCustomJobRequest, string)
Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best
effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or
other methods to check whether the cancellation succeeded or whether the job completed despite
cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job
with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
,
and CustomJob.state is set to CANCELLED
.
Declaration
public virtual ProjectsResource.LocationsResource.CustomJobsResource.CancelRequest Cancel(GoogleCloudAiplatformV1beta1CancelCustomJobRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1CancelCustomJobRequest | body | The body of the request. |
string | name | Required. The name of the CustomJob to cancel. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.CustomJobsResource.CancelRequest |
Create(GoogleCloudAiplatformV1beta1CustomJob, string)
Creates a CustomJob. A created CustomJob right away will be attempted to be run.
Declaration
public virtual ProjectsResource.LocationsResource.CustomJobsResource.CreateRequest Create(GoogleCloudAiplatformV1beta1CustomJob body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudAiplatformV1beta1CustomJob | body | The body of the request. |
string | parent | Required. The resource name of the Location to create the CustomJob in. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.CustomJobsResource.CreateRequest |
Delete(string)
Deletes a CustomJob.
Declaration
public virtual ProjectsResource.LocationsResource.CustomJobsResource.DeleteRequest Delete(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the CustomJob resource to be deleted. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.CustomJobsResource.DeleteRequest |
Get(string)
Gets a CustomJob.
Declaration
public virtual ProjectsResource.LocationsResource.CustomJobsResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the CustomJob resource. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.CustomJobsResource.GetRequest |
List(string)
Lists CustomJobs in a Location.
Declaration
public virtual ProjectsResource.LocationsResource.CustomJobsResource.ListRequest List(string parent)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The resource name of the Location to list the CustomJobs from. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.CustomJobsResource.ListRequest |