Class protos.google.cloud.aiplatform.v1.ScheduleService (3.7.0)

Represents a ScheduleService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1.ScheduleService

Package

@google-cloud/aiplatform

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ScheduleService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ScheduleService;

Creates new ScheduleService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
ScheduleService

RPC service. Useful where requests and/or responses are streamed.

createSchedule(request, callback)

public createSchedule(request: google.cloud.aiplatform.v1.ICreateScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.CreateScheduleCallback): void;

Calls CreateSchedule.

Parameters
Name Description
request ICreateScheduleRequest

CreateScheduleRequest message or plain object
callback CreateScheduleCallback

Node-style callback called with the error, if any, and Schedule
Returns
Type Description
void

createSchedule(request)

public createSchedule(request: google.cloud.aiplatform.v1.ICreateScheduleRequest): Promise<google.cloud.aiplatform.v1.Schedule>;

Calls CreateSchedule.

Parameter
Name Description
request ICreateScheduleRequest

CreateScheduleRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.Schedule>

Promise

deleteSchedule(request, callback)

public deleteSchedule(request: google.cloud.aiplatform.v1.IDeleteScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.DeleteScheduleCallback): void;

Calls DeleteSchedule.

Parameters
Name Description
request IDeleteScheduleRequest

DeleteScheduleRequest message or plain object
callback DeleteScheduleCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteSchedule(request)

public deleteSchedule(request: google.cloud.aiplatform.v1.IDeleteScheduleRequest): Promise<google.longrunning.Operation>;

Calls DeleteSchedule.

Parameter
Name Description
request IDeleteScheduleRequest

DeleteScheduleRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getSchedule(request, callback)

public getSchedule(request: google.cloud.aiplatform.v1.IGetScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.GetScheduleCallback): void;

Calls GetSchedule.

Parameters
Name Description
request IGetScheduleRequest

GetScheduleRequest message or plain object
callback GetScheduleCallback

Node-style callback called with the error, if any, and Schedule
Returns
Type Description
void

getSchedule(request)

public getSchedule(request: google.cloud.aiplatform.v1.IGetScheduleRequest): Promise<google.cloud.aiplatform.v1.Schedule>;

Calls GetSchedule.

Parameter
Name Description
request IGetScheduleRequest

GetScheduleRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.Schedule>

Promise

listSchedules(request, callback)

public listSchedules(request: google.cloud.aiplatform.v1.IListSchedulesRequest, callback: google.cloud.aiplatform.v1.ScheduleService.ListSchedulesCallback): void;

Calls ListSchedules.

Parameters
Name Description
request IListSchedulesRequest

ListSchedulesRequest message or plain object
callback ListSchedulesCallback

Node-style callback called with the error, if any, and ListSchedulesResponse
Returns
Type Description
void

listSchedules(request)

public listSchedules(request: google.cloud.aiplatform.v1.IListSchedulesRequest): Promise<google.cloud.aiplatform.v1.ListSchedulesResponse>;

Calls ListSchedules.

Parameter
Name Description
request IListSchedulesRequest

ListSchedulesRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ListSchedulesResponse>

Promise

pauseSchedule(request, callback)

public pauseSchedule(request: google.cloud.aiplatform.v1.IPauseScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.PauseScheduleCallback): void;

Calls PauseSchedule.

Parameters
Name Description
request IPauseScheduleRequest

PauseScheduleRequest message or plain object
callback PauseScheduleCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

pauseSchedule(request)

public pauseSchedule(request: google.cloud.aiplatform.v1.IPauseScheduleRequest): Promise<google.protobuf.Empty>;

Calls PauseSchedule.

Parameter
Name Description
request IPauseScheduleRequest

PauseScheduleRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

resumeSchedule(request, callback)

public resumeSchedule(request: google.cloud.aiplatform.v1.IResumeScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.ResumeScheduleCallback): void;

Calls ResumeSchedule.

Parameters
Name Description
request IResumeScheduleRequest

ResumeScheduleRequest message or plain object
callback ResumeScheduleCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

resumeSchedule(request)

public resumeSchedule(request: google.cloud.aiplatform.v1.IResumeScheduleRequest): Promise<google.protobuf.Empty>;

Calls ResumeSchedule.

Parameter
Name Description
request IResumeScheduleRequest

ResumeScheduleRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

updateSchedule(request, callback)

public updateSchedule(request: google.cloud.aiplatform.v1.IUpdateScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.UpdateScheduleCallback): void;

Calls UpdateSchedule.

Parameters
Name Description
request IUpdateScheduleRequest

UpdateScheduleRequest message or plain object
callback UpdateScheduleCallback

Node-style callback called with the error, if any, and Schedule
Returns
Type Description
void

updateSchedule(request)

public updateSchedule(request: google.cloud.aiplatform.v1.IUpdateScheduleRequest): Promise<google.cloud.aiplatform.v1.Schedule>;

Calls UpdateSchedule.

Parameter
Name Description
request IUpdateScheduleRequest

UpdateScheduleRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.Schedule>

Promise