Class ExamplesOverride (1.5.0)

public final class ExamplesOverride extends GeneratedMessageV3 implements ExamplesOverrideOrBuilder

Overrides for example-based explanations.

Protobuf type google.cloud.vertexai.v1.ExamplesOverride

Inheritance

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

Implements

ExamplesOverrideOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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

CROWDING_COUNT_FIELD_NUMBER

public static final int CROWDING_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

DATA_FORMAT_FIELD_NUMBER

public static final int DATA_FORMAT_FIELD_NUMBER

Field Value
Type	Description
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

RESTRICTIONS_FIELD_NUMBER

public static final int RESTRICTIONS_FIELD_NUMBER

Field Value
Type	Description
int

RETURN_EMBEDDINGS_FIELD_NUMBER

public static final int RETURN_EMBEDDINGS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ExamplesOverride getDefaultInstance()

Returns
Type	Description
ExamplesOverride

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ExamplesOverride.Builder newBuilder()

Returns
Type	Description
ExamplesOverride.Builder

newBuilder(ExamplesOverride prototype)

public static ExamplesOverride.Builder newBuilder(ExamplesOverride prototype)

Parameter
Name	Description
prototype	ExamplesOverride

Returns
Type	Description
ExamplesOverride.Builder

parseDelimitedFrom(InputStream input)

public static ExamplesOverride parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ExamplesOverride parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExamplesOverride parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExamplesOverride parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ExamplesOverride parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ExamplesOverride parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExamplesOverride

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ExamplesOverride> parser()

Returns
Type	Description
Parser<ExamplesOverride>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCrowdingCount()

public int getCrowdingCount()

The number of neighbors to return that have the same crowding tag.

int32 crowding_count = 2;

Returns
Type	Description
int	The crowdingCount.

getDataFormat()

public ExamplesOverride.DataFormat getDataFormat()

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
Type	Description
ExamplesOverride.DataFormat	The dataFormat.

getDataFormatValue()

public int getDataFormatValue()

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
Type	Description
int	The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ExamplesOverride getDefaultInstanceForType()

Returns
Type	Description
ExamplesOverride

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
Type	Description
int	The neighborCount.

getParserForType()

public Parser<ExamplesOverride> getParserForType()

Returns
Type	Description
Parser<ExamplesOverride>

Overrides

GeneratedMessageV3.getParserForType()

getRestrictions(int index)

public ExamplesRestrictionsNamespace getRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
ExamplesRestrictionsNamespace

getRestrictionsCount()

public int getRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
int

getRestrictionsList()

public List<ExamplesRestrictionsNamespace> getRestrictionsList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
List<ExamplesRestrictionsNamespace>

getRestrictionsOrBuilder(int index)

public ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
ExamplesRestrictionsNamespaceOrBuilder

getRestrictionsOrBuilderList()

public List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.ExamplesRestrictionsNamespaceOrBuilder>

getReturnEmbeddings()

public boolean getReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
Type	Description
boolean	The returnEmbeddings.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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 ExamplesOverride.Builder newBuilderForType()

Returns
Type	Description
ExamplesOverride.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExamplesOverride.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ExamplesOverride.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 ExamplesOverride.Builder toBuilder()

Returns
Type	Description
ExamplesOverride.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException