Represents a CustomJobSpec.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1beta1.ICustomJobSpec);Constructs a new CustomJobSpec.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomJobSpec
Properties to set |
Properties
baseOutputDirectory
public baseOutputDirectory?: (google.cloud.aiplatform.v1beta1.IGcsDestination|null);CustomJobSpec baseOutputDirectory.
enableDashboardAccess
public enableDashboardAccess: boolean;CustomJobSpec enableDashboardAccess.
enableWebAccess
public enableWebAccess: boolean;CustomJobSpec enableWebAccess.
experiment
public experiment: string;CustomJobSpec experiment.
experimentRun
public experimentRun: string;CustomJobSpec experimentRun.
network
public network: string;CustomJobSpec network.
persistentResourceId
public persistentResourceId: string;CustomJobSpec persistentResourceId.
reservedIpRanges
public reservedIpRanges: string[];CustomJobSpec reservedIpRanges.
scheduling
public scheduling?: (google.cloud.aiplatform.v1beta1.IScheduling|null);CustomJobSpec scheduling.
serviceAccount
public serviceAccount: string;CustomJobSpec serviceAccount.
tensorboard
public tensorboard: string;CustomJobSpec tensorboard.
workerPoolSpecs
public workerPoolSpecs: google.cloud.aiplatform.v1beta1.IWorkerPoolSpec[];CustomJobSpec workerPoolSpecs.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1beta1.ICustomJobSpec): google.cloud.aiplatform.v1beta1.CustomJobSpec;Creates a new CustomJobSpec instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICustomJobSpec
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CustomJobSpec | CustomJobSpec instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.CustomJobSpec;Decodes a CustomJobSpec 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 |
CustomJobSpec | CustomJobSpec |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.CustomJobSpec;Decodes a CustomJobSpec message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CustomJobSpec | CustomJobSpec |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1beta1.ICustomJobSpec, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomJobSpec message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomJobSpec
CustomJobSpec 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.ICustomJobSpec, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CustomJobSpec message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICustomJobSpec
CustomJobSpec 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.CustomJobSpec;Creates a CustomJobSpec 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 |
CustomJobSpec | CustomJobSpec |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CustomJobSpec
| 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 CustomJobSpec to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1beta1.CustomJobSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CustomJobSpec message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CustomJobSpec
CustomJobSpec |
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 CustomJobSpec message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|