Class CreateStudyRequest (3.19.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
TypeDescription
int

STUDY_FIELD_NUMBER

public static final int STUDY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateStudyRequest getDefaultInstance()
Returns
TypeDescription
CreateStudyRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateStudyRequest.Builder newBuilder()
Returns
TypeDescription
CreateStudyRequest.Builder

newBuilder(CreateStudyRequest prototype)

public static CreateStudyRequest.Builder newBuilder(CreateStudyRequest prototype)
Parameter
NameDescription
prototypeCreateStudyRequest
Returns
TypeDescription
CreateStudyRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateStudyRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateStudyRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateStudyRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateStudyRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateStudyRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateStudyRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateStudyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateStudyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateStudyRequest> parser()
Returns
TypeDescription
Parser<CreateStudyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateStudyRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateStudyRequest> getParserForType()
Returns
TypeDescription
Parser<CreateStudyRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
StudyOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the study field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateStudyRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateStudyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateStudyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateStudyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateStudyRequest.Builder toBuilder()
Returns
TypeDescription
CreateStudyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException