Represents a Trial.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1.ITrial);Constructs a new Trial.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITrial
Properties to set |
Properties
clientId
public clientId: string;Trial clientId.
customJob
public customJob: string;Trial customJob.
endTime
public endTime?: (google.protobuf.ITimestamp|null);Trial endTime.
finalMeasurement
public finalMeasurement?: (google.cloud.aiplatform.v1.IMeasurement|null);Trial finalMeasurement.
id
public id: string;Trial id.
infeasibleReason
public infeasibleReason: string;Trial infeasibleReason.
measurements
public measurements: google.cloud.aiplatform.v1.IMeasurement[];Trial measurements.
name
public name: string;Trial name.
parameters
public parameters: google.cloud.aiplatform.v1.Trial.IParameter[];Trial parameters.
startTime
public startTime?: (google.protobuf.ITimestamp|null);Trial startTime.
state
public state: (google.cloud.aiplatform.v1.Trial.State|keyof typeof google.cloud.aiplatform.v1.Trial.State);Trial state.
webAccessUris
public webAccessUris: { [k: string]: string };Trial webAccessUris.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1.ITrial): google.cloud.aiplatform.v1.Trial;Creates a new Trial instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITrial
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Trial | Trial instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Trial;Decodes a Trial 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 |
Trial | Trial |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Trial;Decodes a Trial message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Trial | Trial |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1.ITrial, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Trial message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITrial
Trial 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.v1.ITrial, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Trial message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITrial
Trial 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.v1.Trial;Creates a Trial 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 |
Trial | Trial |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Trial
| 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 Trial to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1.Trial, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Trial message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Trial
Trial |
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 Trial message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|