Package com.google.cloud.aiplatform.v1

Interface StudyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Study, Study.Builder
@Generated public interface StudyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. Describes the Study, default value is empty string.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. Describes the Study, default value is empty string.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • hasStudySpec

      boolean hasStudySpec()
       Required. Configuration of the Study.
      .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the studySpec field is set.

    • getStudySpec

      StudySpec getStudySpec()
       Required. Configuration of the Study.
      .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The studySpec.

    • getStudySpecOrBuilder

      StudySpecOrBuilder getStudySpecOrBuilder()
       Required. Configuration of the Study.
      .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];

    • getStateValue

      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:
      The enum numeric value on the wire for state.

    • getState

      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:
      The state.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time at which the study was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Time at which the study was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time at which the study was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getInactiveReason

      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:
      The inactiveReason.

    • getInactiveReasonBytes

      com.google.protobuf.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:
      The bytes for inactiveReason.