Class SyntheticExample (3.74.0)

public final class SyntheticExample extends GeneratedMessageV3 implements SyntheticExampleOrBuilder

Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.

Protobuf type google.cloud.aiplatform.v1.SyntheticExample

Static Fields

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SyntheticExample getDefaultInstance()
Returns
Type Description
SyntheticExample

getDescriptor()

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

newBuilder()

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

newBuilder(SyntheticExample prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SyntheticExample getDefaultInstanceForType()
Returns
Type Description
SyntheticExample

getFields(int index)

public SyntheticField getFields(int index)

Required. A list of fields that constitute an example.

repeated .google.cloud.aiplatform.v1.SyntheticField fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SyntheticField

getFieldsCount()

public int getFieldsCount()

Required. A list of fields that constitute an example.

repeated .google.cloud.aiplatform.v1.SyntheticField fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getFieldsList()

public List<SyntheticField> getFieldsList()

Required. A list of fields that constitute an example.

repeated .google.cloud.aiplatform.v1.SyntheticField fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<SyntheticField>

getFieldsOrBuilder(int index)

public SyntheticFieldOrBuilder getFieldsOrBuilder(int index)

Required. A list of fields that constitute an example.

repeated .google.cloud.aiplatform.v1.SyntheticField fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
SyntheticFieldOrBuilder

getFieldsOrBuilderList()

public List<? extends SyntheticFieldOrBuilder> getFieldsOrBuilderList()

Required. A list of fields that constitute an example.

repeated .google.cloud.aiplatform.v1.SyntheticField fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.SyntheticFieldOrBuilder>

getParserForType()

public Parser<SyntheticExample> getParserForType()
Returns
Type Description
Parser<SyntheticExample>
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 SyntheticExample.Builder newBuilderForType()
Returns
Type Description
SyntheticExample.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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