Interface StudyOrBuilder (3.49.0)

Version 3.49.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.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.