Class PredefinedSplit (3.46.0)

public final class PredefinedSplit extends GeneratedMessageV3 implements PredefinedSplitOrBuilder

Assigns input data to training, validation, and test sets based on the value of a provided key.

Supported only for tabular Datasets.

Protobuf type google.cloud.aiplatform.v1.PredefinedSplit

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PredefinedSplit getDefaultInstance()
Returns
Type Description
PredefinedSplit

getDescriptor()

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

newBuilder()

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

newBuilder(PredefinedSplit prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PredefinedSplit getDefaultInstanceForType()
Returns
Type Description
PredefinedSplit

getKey()

public String getKey()

Required. The key is a name of one of the Dataset's data columns. The value of the key (either the label's value or value in the column) must be one of {training, validation, test}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Required. The key is a name of one of the Dataset's data columns. The value of the key (either the label's value or value in the column) must be one of {training, validation, test}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for key.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 PredefinedSplit.Builder newBuilderForType()
Returns
Type Description
PredefinedSplit.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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