Interface StudyOrBuilder (3.44.0)

public interface StudyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract 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 abstract 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

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getState()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.