Class Study.Builder

  • All Implemented Interfaces:
    StudyOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Study

    public static final class Study.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
    implements StudyOrBuilder
     A message representing a Study.
     
    Protobuf type google.cloud.aiplatform.v1.Study
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • clear

        public Study.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • getDefaultInstanceForType

        public Study getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public Study build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public Study buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public Study.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • setField

        public Study.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • clearField

        public Study.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • clearOneof

        public Study.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • setRepeatedField

        public Study.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • addRepeatedField

        public Study.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • mergeFrom

        public Study.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Study.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • mergeFrom

        public Study.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Study.Builder>
        Throws:
        IOException
      • 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];
        Specified by:
        getName in interface StudyOrBuilder
        Returns:
        The name.
      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface StudyOrBuilder
        Returns:
        The bytes for name.
      • setName

        public Study.Builder setName​(String value)
         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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public Study.Builder clearName()
         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:
        This builder for chaining.
      • setNameBytes

        public Study.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • getDisplayName

        public String getDisplayName()
         Required. Describes the Study, default value is empty string.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface StudyOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

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

        public Study.Builder setDisplayName​(String value)
         Required. Describes the Study, default value is empty string.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.
      • clearDisplayName

        public Study.Builder clearDisplayName()
         Required. Describes the Study, default value is empty string.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setDisplayNameBytes

        public Study.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         Required. Describes the Study, default value is empty string.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.
      • hasStudySpec

        public boolean hasStudySpec()
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasStudySpec in interface StudyOrBuilder
        Returns:
        Whether the studySpec field is set.
      • getStudySpec

        public StudySpec getStudySpec()
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStudySpec in interface StudyOrBuilder
        Returns:
        The studySpec.
      • setStudySpec

        public Study.Builder setStudySpec​(StudySpec value)
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
      • setStudySpec

        public Study.Builder setStudySpec​(StudySpec.Builder builderForValue)
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
      • mergeStudySpec

        public Study.Builder mergeStudySpec​(StudySpec value)
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
      • clearStudySpec

        public Study.Builder clearStudySpec()
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
      • getStudySpecBuilder

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

        public StudySpecOrBuilder getStudySpecOrBuilder()
         Required. Configuration of the Study.
         
        .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStudySpecOrBuilder in interface StudyOrBuilder
      • 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];
        Specified by:
        getStateValue in interface StudyOrBuilder
        Returns:
        The enum numeric value on the wire for state.
      • setStateValue

        public Study.Builder setStateValue​(int value)
         Output only. The detailed state of a Study.
         
        .google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.
      • 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];
        Specified by:
        getState in interface StudyOrBuilder
        Returns:
        The state.
      • setState

        public Study.Builder setState​(Study.State value)
         Output only. The detailed state of a Study.
         
        .google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.
      • clearState

        public Study.Builder clearState()
         Output only. The detailed state of a Study.
         
        .google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • 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];
        Specified by:
        hasCreateTime in interface StudyOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface StudyOrBuilder
        Returns:
        The createTime.
      • setCreateTime

        public Study.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Time at which the study was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setCreateTime

        public Study.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Time at which the study was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCreateTime

        public Study.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Time at which the study was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearCreateTime

        public Study.Builder clearCreateTime()
         Output only. Time at which the study was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeBuilder

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

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface StudyOrBuilder
      • 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];
        Specified by:
        getInactiveReason in interface StudyOrBuilder
        Returns:
        The inactiveReason.
      • getInactiveReasonBytes

        public 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];
        Specified by:
        getInactiveReasonBytes in interface StudyOrBuilder
        Returns:
        The bytes for inactiveReason.
      • setInactiveReason

        public Study.Builder setInactiveReason​(String value)
         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];
        Parameters:
        value - The inactiveReason to set.
        Returns:
        This builder for chaining.
      • clearInactiveReason

        public Study.Builder clearInactiveReason()
         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:
        This builder for chaining.
      • setInactiveReasonBytes

        public Study.Builder setInactiveReasonBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for inactiveReason to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final Study.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>
      • mergeUnknownFields

        public final Study.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Study.Builder>