Study.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<Study.Builder>
    - - com.google.cloud.aiplatform.v1.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.GeneratedMessage.Builder<Study.Builder>
implements StudyOrBuilder
```
```
 A message representing a Study.
 
```
Protobuf type google.cloud.aiplatform.v1.Study

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Study`	`build()`
`Study`	`buildPartial()`
`Study.Builder`	`clear()`
`Study.Builder`	`clearCreateTime()` Output only.
`Study.Builder`	`clearDisplayName()` Required.
`Study.Builder`	`clearInactiveReason()` Output only.
`Study.Builder`	`clearName()` Output only.
`Study.Builder`	`clearState()` Output only.
`Study.Builder`	`clearStudySpec()` Required.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.Timestamp.Builder`	`getCreateTimeBuilder()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`Study`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`String`	`getInactiveReason()` Output only.
`com.google.protobuf.ByteString`	`getInactiveReasonBytes()` Output only.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`Study.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`StudySpec`	`getStudySpec()` Required.
`StudySpec.Builder`	`getStudySpecBuilder()` Required.
`StudySpecOrBuilder`	`getStudySpecOrBuilder()` Required.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasStudySpec()` Required.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Study.Builder`	`mergeCreateTime(com.google.protobuf.Timestamp value)` Output only.
`Study.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Study.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Study.Builder`	`mergeFrom(Study other)`
`Study.Builder`	`mergeStudySpec(StudySpec value)` Required.
`Study.Builder`	`setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)` Output only.
`Study.Builder`	`setCreateTime(com.google.protobuf.Timestamp value)` Output only.
`Study.Builder`	`setDisplayName(String value)` Required.
`Study.Builder`	`setDisplayNameBytes(com.google.protobuf.ByteString value)` Required.
`Study.Builder`	`setInactiveReason(String value)` Output only.
`Study.Builder`	`setInactiveReasonBytes(com.google.protobuf.ByteString value)` Output only.
`Study.Builder`	`setName(String value)` Output only.
`Study.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Output only.
`Study.Builder`	`setState(Study.State value)` Output only.
`Study.Builder`	`setStateValue(int value)` Output only.
`Study.Builder`	`setStudySpec(StudySpec.Builder builderForValue)` Required.
`Study.Builder`	`setStudySpec(StudySpec value)` Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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
  - 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>
  - mergeFrom
```
public Study.Builder mergeFrom(Study other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.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.

Class Study.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getDisplayName

getDisplayNameBytes

setDisplayName

clearDisplayName

setDisplayNameBytes

hasStudySpec

getStudySpec

setStudySpec

setStudySpec

mergeStudySpec

clearStudySpec

getStudySpecBuilder

getStudySpecOrBuilder

getStateValue

setStateValue

getState

setState

clearState

hasCreateTime

getCreateTime

setCreateTime

setCreateTime

mergeCreateTime

clearCreateTime

getCreateTimeBuilder

getCreateTimeOrBuilder

getInactiveReason

getInactiveReasonBytes

setInactiveReason

clearInactiveReason

setInactiveReasonBytes