Class ExamplesOverride (0.8.0) 

publicfinalclass ExamplesOverrideextendsGeneratedMessageV3implementsExamplesOverrideOrBuilder

Overrides for example-based explanations.

Protobuf type google.cloud.vertexai.v1.ExamplesOverride

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

CROWDING_COUNT_FIELD_NUMBER

publicstaticfinalintCROWDING_COUNT_FIELD_NUMBER
Field Value
Type Description
int

DATA_FORMAT_FIELD_NUMBER

publicstaticfinalintDATA_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

NEIGHBOR_COUNT_FIELD_NUMBER

publicstaticfinalintNEIGHBOR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RESTRICTIONS_FIELD_NUMBER

publicstaticfinalintRESTRICTIONS_FIELD_NUMBER
Field Value
Type Description
int

RETURN_EMBEDDINGS_FIELD_NUMBER

publicstaticfinalintRETURN_EMBEDDINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticExamplesOverridegetDefaultInstance()
Returns
Type Description
ExamplesOverride

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticExamplesOverride.BuildernewBuilder()
Returns
Type Description
ExamplesOverride.Builder

newBuilder(ExamplesOverride prototype)

publicstaticExamplesOverride.BuildernewBuilder(ExamplesOverrideprototype)
Parameter
Name Description
prototype ExamplesOverride
Returns
Type Description
ExamplesOverride.Builder

parseDelimitedFrom(InputStream input)

publicstaticExamplesOverrideparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExamplesOverrideparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticExamplesOverrideparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticExamplesOverrideparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticExamplesOverrideparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticExamplesOverrideparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticExamplesOverrideparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExamplesOverrideparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticExamplesOverrideparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExamplesOverrideparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticExamplesOverrideparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticExamplesOverrideparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExamplesOverride
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<ExamplesOverride>parser()
Returns
Type Description
Parser<ExamplesOverride>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCrowdingCount()

publicintgetCrowdingCount()

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

int32 crowding_count = 2;

Returns
Type Description
int

The crowdingCount.

getDataFormat()

publicExamplesOverride.DataFormatgetDataFormat()

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()

publicintgetDataFormatValue()

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()

publicExamplesOverridegetDefaultInstanceForType()
Returns
Type Description
ExamplesOverride

getNeighborCount()

publicintgetNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
Type Description
int

The neighborCount.

getParserForType()

publicParser<ExamplesOverride>getParserForType()
Returns
Type Description
Parser<ExamplesOverride>
Overrides

getRestrictions(int index)

publicExamplesRestrictionsNamespacegetRestrictions(intindex)

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()

publicintgetRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
Type Description
int

getRestrictionsList()

publicList<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)

publicExamplesRestrictionsNamespaceOrBuildergetRestrictionsOrBuilder(intindex)

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()

publicList<?extendsExamplesRestrictionsNamespaceOrBuilder>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()

publicbooleangetReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
Type Description
boolean

The returnEmbeddings.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicExamplesOverride.BuildernewBuilderForType()
Returns
Type Description
ExamplesOverride.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedExamplesOverride.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExamplesOverride.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicExamplesOverride.BuildertoBuilder()
Returns
Type Description
ExamplesOverride.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.