Class Study.Builder (3.43.0)

public static final class Study.Builder extends GeneratedMessageV3.Builder<Study.Builder> implements StudyOrBuilder

A message representing a Study.

Protobuf type google.cloud.aiplatform.v1.Study

Implements

StudyOrBuilder

Static 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
Overrides

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
Overrides

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
Overrides

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
Overrides

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
Overrides

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
Overrides

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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Study.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Study.Builder
Overrides

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
Overrides

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 String

The 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 ByteString

The 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
Overrides

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 String

The 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 ByteString

The 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 String

The 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 ByteString

The 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
Overrides

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.State

The 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 int

The 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
Overrides