Class CreateStudyRequest (3.48.0)

public final class CreateStudyRequest extends GeneratedMessageV3 implements CreateStudyRequestOrBuilder

Request message for VizierService.CreateStudy.

Protobuf type google.cloud.aiplatform.v1.CreateStudyRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

STUDY_FIELD_NUMBER

public static final int STUDY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateStudyRequest getDefaultInstance()
Returns
Type Description
CreateStudyRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateStudyRequest.Builder newBuilder()
Returns
Type Description
CreateStudyRequest.Builder

newBuilder(CreateStudyRequest prototype)

public static CreateStudyRequest.Builder newBuilder(CreateStudyRequest prototype)
Parameter
Name Description
prototype CreateStudyRequest
Returns
Type Description
CreateStudyRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateStudyRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateStudyRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateStudyRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateStudyRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateStudyRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateStudyRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateStudyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateStudyRequest> parser()
Returns
Type Description
Parser<CreateStudyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateStudyRequest getDefaultInstanceForType()
Returns
Type Description
CreateStudyRequest

getParent()

public String getParent()

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateStudyRequest> getParserForType()
Returns
Type Description
Parser<CreateStudyRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStudy()

public Study getStudy()

Required. The Study configuration used to create the Study.

.google.cloud.aiplatform.v1.Study study = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Study

The study.

getStudyOrBuilder()

public StudyOrBuilder getStudyOrBuilder()

Required. The Study configuration used to create the Study.

.google.cloud.aiplatform.v1.Study study = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StudyOrBuilder

hasStudy()

public boolean hasStudy()

Required. The Study configuration used to create the Study.

.google.cloud.aiplatform.v1.Study study = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the study field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateStudyRequest.Builder newBuilderForType()
Returns
Type Description
CreateStudyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateStudyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateStudyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateStudyRequest.Builder toBuilder()
Returns
Type Description
CreateStudyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException