Class protos.google.cloud.aiplatform.v1beta1.Schedule (3.15.0)

Represents a Schedule.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.ISchedule);

Constructs a new Schedule.

Parameter
Name Description
properties ISchedule

Properties to set

Properties

allowQueueing

public allowQueueing: boolean;

Schedule allowQueueing.

catchUp

public catchUp: boolean;

Schedule catchUp.

createPipelineJobRequest

public createPipelineJobRequest?: (google.cloud.aiplatform.v1beta1.ICreatePipelineJobRequest|null);

Schedule createPipelineJobRequest.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Schedule createTime.

cron

public cron?: (string|null);

Schedule cron.

displayName

public displayName: string;

Schedule displayName.

endTime

public endTime?: (google.protobuf.ITimestamp|null);

Schedule endTime.

lastPauseTime

public lastPauseTime?: (google.protobuf.ITimestamp|null);

Schedule lastPauseTime.

lastResumeTime

public lastResumeTime?: (google.protobuf.ITimestamp|null);

Schedule lastResumeTime.

lastScheduledRunResponse

public lastScheduledRunResponse?: (google.cloud.aiplatform.v1beta1.Schedule.IRunResponse|null);

Schedule lastScheduledRunResponse.

maxConcurrentRunCount

public maxConcurrentRunCount: (number|Long|string);

Schedule maxConcurrentRunCount.

maxRunCount

public maxRunCount: (number|Long|string);

Schedule maxRunCount.

name

public name: string;

Schedule name.

nextRunTime

public nextRunTime?: (google.protobuf.ITimestamp|null);

Schedule nextRunTime.

request

public request?: "createPipelineJobRequest";

Schedule request.

startedRunCount

public startedRunCount: (number|Long|string);

Schedule startedRunCount.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

Schedule startTime.

state

public state: (google.cloud.aiplatform.v1beta1.Schedule.State|keyof typeof google.cloud.aiplatform.v1beta1.Schedule.State);

Schedule state.

timeSpecification

public timeSpecification?: "cron";

Schedule timeSpecification.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Schedule updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.ISchedule): google.cloud.aiplatform.v1beta1.Schedule;

Creates a new Schedule instance using the specified properties.

Parameter
Name Description
properties ISchedule

Properties to set
Returns
Type Description
Schedule

Schedule instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.Schedule;

Decodes a Schedule message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
Schedule

Schedule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.Schedule;

Decodes a Schedule message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
Schedule

Schedule

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.ISchedule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Schedule message. Does not implicitly messages.

Parameters
Name Description
message ISchedule

Schedule message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ISchedule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Schedule message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ISchedule

Schedule message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.Schedule;

Creates a Schedule message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
Schedule

Schedule

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Schedule

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Schedule to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1beta1.Schedule, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Schedule message. Also converts values to other types if specified.

Parameters
Name Description
message Schedule

Schedule
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Schedule message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not