Represents a PipelineJob.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1beta1.IPipelineJob);Constructs a new PipelineJob.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPipelineJob
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);PipelineJob createTime.
displayName
public displayName: string;PipelineJob displayName.
encryptionSpec
public encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null);PipelineJob encryptionSpec.
endTime
public endTime?: (google.protobuf.ITimestamp|null);PipelineJob endTime.
error
public error?: (google.rpc.IStatus|null);PipelineJob error.
jobDetail
public jobDetail?: (google.cloud.aiplatform.v1beta1.IPipelineJobDetail|null);PipelineJob jobDetail.
labels
public labels: { [k: string]: string };PipelineJob labels.
name
public name: string;PipelineJob name.
network
public network: string;PipelineJob network.
pipelineSpec
public pipelineSpec?: (google.protobuf.IStruct|null);PipelineJob pipelineSpec.
reservedIpRanges
public reservedIpRanges: string[];PipelineJob reservedIpRanges.
runtimeConfig
public runtimeConfig?: (google.cloud.aiplatform.v1beta1.PipelineJob.IRuntimeConfig|null);PipelineJob runtimeConfig.
scheduleName
public scheduleName: string;PipelineJob scheduleName.
serviceAccount
public serviceAccount: string;PipelineJob serviceAccount.
startTime
public startTime?: (google.protobuf.ITimestamp|null);PipelineJob startTime.
state
public state: (google.cloud.aiplatform.v1beta1.PipelineState|keyof typeof google.cloud.aiplatform.v1beta1.PipelineState);PipelineJob state.
templateMetadata
public templateMetadata?: (google.cloud.aiplatform.v1beta1.IPipelineTemplateMetadata|null);PipelineJob templateMetadata.
templateUri
public templateUri: string;PipelineJob templateUri.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);PipelineJob updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1beta1.IPipelineJob): google.cloud.aiplatform.v1beta1.PipelineJob;Creates a new PipelineJob instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPipelineJob
Properties to set |
| Returns | |
|---|---|
| Type | Description |
PipelineJob | PipelineJob instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.PipelineJob;Decodes a PipelineJob 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 |
PipelineJob | PipelineJob |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.PipelineJob;Decodes a PipelineJob message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
PipelineJob | PipelineJob |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1beta1.IPipelineJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PipelineJob message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPipelineJob
PipelineJob 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.IPipelineJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PipelineJob message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPipelineJob
PipelineJob 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.PipelineJob;Creates a PipelineJob 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 |
PipelineJob | PipelineJob |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PipelineJob
| 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 PipelineJob to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1beta1.PipelineJob, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a PipelineJob message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
PipelineJob
PipelineJob |
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 PipelineJob message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|