Send feedback
Class Study (3.56.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.56.0 keyboard_arrow_down
public final class Study extends GeneratedMessageV3 implements StudyOrBuilder
A message representing a Study.
Protobuf type google.cloud.aiplatform.v1.Study
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int INACTIVE_REASON_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STUDY_SPEC_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static Study getDefaultInstance ()
Returns
Type Description
Study
public static final Descriptors . Descriptor getDescriptor ()
public static Study . Builder newBuilder ()
public static Study . Builder newBuilder ( Study prototype )
Parameter
Name Description
prototypeStudy
public static Study parseDelimitedFrom ( InputStream input )
Returns
Type Description
Study
public static Study parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Study
public static Study parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Study
public static Study parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Study
public static Study parseFrom ( ByteString data )
Returns
Type Description
Study
public static Study parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Study
public static Study parseFrom ( CodedInputStream input )
Returns
Type Description
Study
public static Study parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Study
public static Study parseFrom ( InputStream input )
Returns
Type Description
Study
public static Study parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Study
public static Study parseFrom ( ByteBuffer data )
Returns
Type Description
Study
public static Study parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Study
public static Parser<Study> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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];
Returns
Type Description
Timestamp The createTime.
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 Study getDefaultInstanceForType ()
Returns
Type Description
Study
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.
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.
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.
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.
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.
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.
public Parser<Study> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
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];
Returns
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];
Returns
Type Description
StudySpec The studySpec.
public StudySpecOrBuilder getStudySpecOrBuilder ()
Required. Configuration of the Study.
.google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];
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.
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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public Study . Builder newBuilderForType ()
protected Study . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public Study . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
