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