public final class Study extends GeneratedMessageV3 implements StudyOrBuilder
LINT.IfChange
A message representing a Study.
Protobuf type google.cloud.aiplatform.v1.Study
Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int INACTIVE_REASON_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
public static final int STUDY_SPEC_FIELD_NUMBER
Field Value
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Time at which the study was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time at which the study was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public static Study getDefaultInstance()
Returns
public Study getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public String getDisplayName()
Required. Describes the Study, default value is empty string.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. Describes the Study, default value is empty string.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for displayName.
|
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];
| Type | Description |
| String | The inactiveReason.
|
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];
| Type | Description |
| ByteString | The bytes for inactiveReason.
|
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];
| Type | Description |
| String | The name.
|
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];
public Parser<Study> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
public StudySpec getStudySpec()
Required. Configuration of the Study.
.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
public StudySpecOrBuilder getStudySpecOrBuilder()
Required. Configuration of the Study.
.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasCreateTime()
Output only. Time at which the study was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasStudySpec()
Required. Configuration of the Study.
.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the studySpec field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public static Study.Builder newBuilder()
Returns
public static Study.Builder newBuilder(Study prototype)
Parameter
| Name | Description |
| prototype | Study
|
Returns
public Study.Builder newBuilderForType()
Returns
protected Study.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Study parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Study parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Study parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static Study parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Study parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static Study parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Study parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Study parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Study parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Study parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Study parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static Study parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<Study> parser()
Returns
public Study.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
