Class Study (3.42.0)

public final class Study extends GeneratedMessageV3 implements StudyOrBuilder

A message representing a Study.

Protobuf type google.cloud.aiplatform.v1.Study

Implements

StudyOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

INACTIVE_REASON_FIELD_NUMBER

public static final int INACTIVE_REASON_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STUDY_SPEC_FIELD_NUMBER

public static final int STUDY_SPEC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Study getDefaultInstance()
Returns
Type Description
Study

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Study.Builder newBuilder()
Returns
Type Description
Study.Builder

newBuilder(Study prototype)

public static Study.Builder newBuilder(Study prototype)
Parameter
Name Description
prototype Study
Returns
Type Description
Study.Builder

parseDelimitedFrom(InputStream input)

public static Study parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Study
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Study parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Study
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Study parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Study
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Study parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Study
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Study parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Study
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Study parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Study
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Study parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Study
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Study parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Study
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Study parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Study
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Study parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Study
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Study parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Study
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Study parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Study
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Study> parser()
Returns
Type Description
Parser<Study>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time at which the study was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the study was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Study getDefaultInstanceForType()
Returns
Type Description
Study

getDisplayName()

public String getDisplayName()

Required. Describes the Study, default value is empty string.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Describes the Study, default value is empty string.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getInactiveReason()

public String getInactiveReason()

Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

string inactive_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The inactiveReason.

getInactiveReasonBytes()

public ByteString getInactiveReasonBytes()

Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

string inactive_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for inactiveReason.

getName()

public String getName()

Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Study> getParserForType()
Returns
Type Description
Parser<Study>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Study.State getState()

Output only. The detailed state of a Study.

.google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Study.State

The state.

getStateValue()

public int getStateValue()

Output only. The detailed state of a Study.

.google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStudySpec()

public StudySpec getStudySpec()

Required. Configuration of the Study.

.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StudySpec

The studySpec.

getStudySpecOrBuilder()

public StudySpecOrBuilder getStudySpecOrBuilder()

Required. Configuration of the Study.

.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StudySpecOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time at which the study was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasStudySpec()

public boolean hasStudySpec()

Required. Configuration of the Study.

.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the studySpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Study.Builder newBuilderForType()
Returns
Type Description
Study.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Study.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Study.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Study.Builder toBuilder()
Returns
Type Description
Study.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException