Class Examples (3.30.0)

Version 3.30.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class Examples extends GeneratedMessageV3 implements ExamplesOrBuilder

Example-based explainability that returns the nearest neighbors from the provided dataset.

Protobuf type google.cloud.aiplatform.v1beta1.Examples

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Examples

Implements

ExamplesOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

EXAMPLE_GCS_SOURCE_FIELD_NUMBER

public static final int EXAMPLE_GCS_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER

public static final int NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

PRESETS_FIELD_NUMBER

public static final int PRESETS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Examples getDefaultInstance()

Returns
Type	Description
Examples

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Examples.Builder newBuilder()

Returns
Type	Description
Examples.Builder

newBuilder(Examples prototype)

public static Examples.Builder newBuilder(Examples prototype)

Parameter
Name	Description
prototype	Examples

Returns
Type	Description
Examples.Builder

parseDelimitedFrom(InputStream input)

public static Examples parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Examples

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Examples parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Examples

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Examples parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Examples

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Examples parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Examples

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Examples parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Examples

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Examples parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Examples

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Examples parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Examples> parser()

Returns
Type	Description
Parser<Examples>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getConfigCase()

public Examples.ConfigCase getConfigCase()

Returns
Type	Description
Examples.ConfigCase

getDefaultInstanceForType()

public Examples getDefaultInstanceForType()

Returns
Type	Description
Examples

getExampleGcsSource()

public Examples.ExampleGcsSource getExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
Examples.ExampleGcsSource	The exampleGcsSource.

getExampleGcsSourceOrBuilder()

public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
Examples.ExampleGcsSourceOrBuilder

getGcsSource()

public GcsSource getGcsSource()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type	Description
GcsSource	The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type	Description
GcsSourceOrBuilder

getNearestNeighborSearchConfig()

public Value getNearestNeighborSearchConfig()

The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type	Description
Value	The nearestNeighborSearchConfig.

getNearestNeighborSearchConfigOrBuilder()

public ValueOrBuilder getNearestNeighborSearchConfigOrBuilder()

The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type	Description
ValueOrBuilder

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Returns
Type	Description
int	The neighborCount.

getParserForType()

public Parser<Examples> getParserForType()

Returns
Type	Description
Parser<Examples>

Overrides

GeneratedMessageV3.getParserForType()

getPresets()

public Presets getPresets()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.aiplatform.v1beta1.Presets presets = 4;

Returns
Type	Description
Presets	The presets.

getPresetsOrBuilder()

public PresetsOrBuilder getPresetsOrBuilder()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.aiplatform.v1beta1.Presets presets = 4;

Returns
Type	Description
PresetsOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSourceCase()

public Examples.SourceCase getSourceCase()

Returns
Type	Description
Examples.SourceCase

hasExampleGcsSource()

public boolean hasExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
boolean	Whether the exampleGcsSource field is set.

hasGcsSource()

public boolean hasGcsSource()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type	Description
boolean	Whether the gcsSource field is set.

hasNearestNeighborSearchConfig()

public boolean hasNearestNeighborSearchConfig()

The full configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type	Description
boolean	Whether the nearestNeighborSearchConfig field is set.

hasPresets()

public boolean hasPresets()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.aiplatform.v1beta1.Presets presets = 4;

Returns
Type	Description
boolean	Whether the presets field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Examples.Builder newBuilderForType()

Returns
Type	Description
Examples.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Examples.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Examples.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Examples.Builder toBuilder()

Returns
Type	Description
Examples.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException