- 3.77.0 (latest)
- 3.76.0
- 3.75.0
- 3.74.0
- 3.73.0
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 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 static final class Study.Builder extends GeneratedMessageV3.Builder<Study.Builder> implements StudyOrBuilderA message representing a Study.
 Protobuf type google.cloud.aiplatform.v1.Study
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Study.BuilderImplements
StudyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
| Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Study.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
build()
public Study build()| Returns | |
|---|---|
| Type | Description | 
| Study | |
buildPartial()
public Study buildPartial()| Returns | |
|---|---|
| Type | Description | 
| Study | |
clear()
public Study.Builder clear()| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
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];
 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
clearDisplayName()
public Study.Builder clearDisplayName()Required. Describes the Study, default value is empty string.
 string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
clearField(Descriptors.FieldDescriptor field)
public Study.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
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 | |
|---|---|
| Type | Description | 
| Study.Builder | 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 | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
clearOneof(Descriptors.OneofDescriptor oneof)
public Study.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
| oneof | OneofDescriptor | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
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 | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
clearStudySpec()
public Study.Builder clearStudySpec()Required. Configuration of the Study.
 
 .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
clone()
public Study.Builder clone()| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
getCreateTime()
public 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. | 
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Time at which the study was created.
 
 .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
| Builder | |
getCreateTimeOrBuilder()
public 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 | |
getDefaultInstanceForType()
public Study getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
| Study | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
| Descriptor | |
getDisplayName()
public 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 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 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 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 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 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 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 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 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. | 
getStudySpecBuilder()
public StudySpec.Builder getStudySpecBuilder()Required. Configuration of the Study.
 
 .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
| StudySpec.Builder | |
getStudySpecOrBuilder()
public 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 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 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. | 
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
| FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
| boolean | |
mergeCreateTime(Timestamp value)
public Study.Builder mergeCreateTime(Timestamp value)Output only. Time at which the study was created.
 
 .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | Timestamp | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
mergeFrom(Study other)
public Study.Builder mergeFrom(Study other)| Parameter | |
|---|---|
| Name | Description | 
| other | Study | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Study.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
| input | CodedInputStream | 
| extensionRegistry | ExtensionRegistryLite | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
| Exceptions | |
|---|---|
| Type | Description | 
| IOException | |
mergeFrom(Message other)
public Study.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
| other | Message | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
mergeStudySpec(StudySpec value)
public Study.Builder mergeStudySpec(StudySpec value)Required. Configuration of the Study.
 
 .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | StudySpec | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Study.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setCreateTime(Timestamp value)
public Study.Builder setCreateTime(Timestamp value)Output only. Time at which the study was created.
 
 .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | Timestamp | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Study.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Time at which the study was created.
 
 .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
| builderForValue | Builder | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setDisplayName(String value)
public Study.Builder setDisplayName(String value)Required. Describes the Study, default value is empty string.
 string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description | 
| value | StringThe displayName to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setDisplayNameBytes(ByteString value)
public Study.Builder setDisplayNameBytes(ByteString value)Required. Describes the Study, default value is empty string.
 string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description | 
| value | ByteStringThe bytes for displayName to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setField(Descriptors.FieldDescriptor field, Object value)
public Study.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setInactiveReason(String value)
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];
| Parameter | |
|---|---|
| Name | Description | 
| value | StringThe inactiveReason to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setInactiveReasonBytes(ByteString value)
public Study.Builder setInactiveReasonBytes(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];
| Parameter | |
|---|---|
| Name | Description | 
| value | ByteStringThe bytes for inactiveReason to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setName(String value)
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];
| Parameter | |
|---|---|
| Name | Description | 
| value | StringThe name to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setNameBytes(ByteString value)
public Study.Builder setNameBytes(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];
| Parameter | |
|---|---|
| Name | Description | 
| value | ByteStringThe bytes for name to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Study.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| index | int | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setState(Study.State value)
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];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | Study.StateThe state to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setStateValue(int value)
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];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | intThe enum numeric value on the wire for state to set. | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | This builder for chaining. | 
setStudySpec(StudySpec value)
public Study.Builder setStudySpec(StudySpec value)Required. Configuration of the Study.
 
 .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | StudySpec | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setStudySpec(StudySpec.Builder builderForValue)
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];
 
| Parameter | |
|---|---|
| Name | Description | 
| builderForValue | StudySpec.Builder | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Study.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| Study.Builder | |