com.google.cloud.vertexai.api

Class ExamplesOverride

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vertexai.api.ExamplesOverride

All Implemented Interfaces:

ExamplesOverrideOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ExamplesOverride
extends com.google.protobuf.GeneratedMessageV3
implements ExamplesOverrideOrBuilder

 Overrides for example-based explanations.
 

Protobuf type google.cloud.vertexai.v1.ExamplesOverride

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExamplesOverride.Builder Overrides for example-based explanations.
static class	ExamplesOverride.DataFormat Data format enum.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CROWDING_COUNT_FIELD_NUMBER
static int	DATA_FORMAT_FIELD_NUMBER
static int	NEIGHBOR_COUNT_FIELD_NUMBER
static int	RESTRICTIONS_FIELD_NUMBER
static int	RETURN_EMBEDDINGS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getCrowdingCount() The number of neighbors to return that have the same crowding tag.
ExamplesOverride.DataFormat	getDataFormat() The format of the data being provided with each call.
int	getDataFormatValue() The format of the data being provided with each call.
static ExamplesOverride	getDefaultInstance()
ExamplesOverride	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getNeighborCount() The number of neighbors to return.
com.google.protobuf.Parser<ExamplesOverride>	getParserForType()
ExamplesRestrictionsNamespace	getRestrictions(int index) Restrict the resulting nearest neighbors to respect these constraints.
int	getRestrictionsCount() Restrict the resulting nearest neighbors to respect these constraints.
List<ExamplesRestrictionsNamespace>	getRestrictionsList() Restrict the resulting nearest neighbors to respect these constraints.
ExamplesRestrictionsNamespaceOrBuilder	getRestrictionsOrBuilder(int index) Restrict the resulting nearest neighbors to respect these constraints.
List<? extends ExamplesRestrictionsNamespaceOrBuilder>	getRestrictionsOrBuilderList() Restrict the resulting nearest neighbors to respect these constraints.
boolean	getReturnEmbeddings() If true, return the embeddings instead of neighbors.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExamplesOverride.Builder	newBuilder()
static ExamplesOverride.Builder	newBuilder(ExamplesOverride prototype)
ExamplesOverride.Builder	newBuilderForType()
protected ExamplesOverride.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExamplesOverride	parseDelimitedFrom(InputStream input)
static ExamplesOverride	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExamplesOverride	parseFrom(byte[] data)
static ExamplesOverride	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExamplesOverride	parseFrom(ByteBuffer data)
static ExamplesOverride	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExamplesOverride	parseFrom(com.google.protobuf.ByteString data)
static ExamplesOverride	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExamplesOverride	parseFrom(com.google.protobuf.CodedInputStream input)
static ExamplesOverride	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExamplesOverride	parseFrom(InputStream input)
static ExamplesOverride	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExamplesOverride>	parser()
ExamplesOverride.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

CROWDING_COUNT_FIELD_NUMBER

public static final int CROWDING_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

RESTRICTIONS_FIELD_NUMBER

public static final int RESTRICTIONS_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_EMBEDDINGS_FIELD_NUMBER

public static final int RETURN_EMBEDDINGS_FIELD_NUMBER

See Also:

Constant Field Values

DATA_FORMAT_FIELD_NUMBER

public static final int DATA_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getNeighborCount

public int getNeighborCount()

 The number of neighbors to return.
 

int32 neighbor_count = 1;

Specified by:

getNeighborCount in interface ExamplesOverrideOrBuilder

Returns:

The neighborCount.

getCrowdingCount

public int getCrowdingCount()

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

int32 crowding_count = 2;

Specified by:

getCrowdingCount in interface ExamplesOverrideOrBuilder

Returns:

The crowdingCount.

getRestrictionsList

public List<ExamplesRestrictionsNamespace> getRestrictionsList()

 Restrict the resulting nearest neighbors to respect these constraints.
 

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

Specified by:

getRestrictionsList in interface ExamplesOverrideOrBuilder

getRestrictionsOrBuilderList

public List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()

 Restrict the resulting nearest neighbors to respect these constraints.
 

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

Specified by:

getRestrictionsOrBuilderList in interface ExamplesOverrideOrBuilder

getRestrictionsCount

public int getRestrictionsCount()

 Restrict the resulting nearest neighbors to respect these constraints.
 

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

Specified by:

getRestrictionsCount in interface ExamplesOverrideOrBuilder

getRestrictions

public ExamplesRestrictionsNamespace getRestrictions(int index)

 Restrict the resulting nearest neighbors to respect these constraints.
 

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

Specified by:

getRestrictions in interface ExamplesOverrideOrBuilder

getRestrictionsOrBuilder

public ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)

 Restrict the resulting nearest neighbors to respect these constraints.
 

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

Specified by:

getRestrictionsOrBuilder in interface ExamplesOverrideOrBuilder

getReturnEmbeddings

public boolean getReturnEmbeddings()

 If true, return the embeddings instead of neighbors.
 

bool return_embeddings = 4;

Specified by:

getReturnEmbeddings in interface ExamplesOverrideOrBuilder

Returns:

The returnEmbeddings.

getDataFormatValue

public int getDataFormatValue()

 The format of the data being provided with each call.
 

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

Specified by:

getDataFormatValue in interface ExamplesOverrideOrBuilder

Returns:

The enum numeric value on the wire for dataFormat.

getDataFormat

public ExamplesOverride.DataFormat getDataFormat()

 The format of the data being provided with each call.
 

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

Specified by:

getDataFormat in interface ExamplesOverrideOrBuilder

Returns:

The dataFormat.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ExamplesOverride parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExamplesOverride parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExamplesOverride parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExamplesOverride parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExamplesOverride parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExamplesOverride parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExamplesOverride parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static ExamplesOverride parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExamplesOverride parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExamplesOverride parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static ExamplesOverride parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static ExamplesOverride parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public ExamplesOverride.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExamplesOverride.Builder newBuilder()

newBuilder

public static ExamplesOverride.Builder newBuilder(ExamplesOverride prototype)

toBuilder

public ExamplesOverride.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExamplesOverride.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExamplesOverride getDefaultInstance()

parser

public static com.google.protobuf.Parser<ExamplesOverride> parser()

getParserForType

public com.google.protobuf.Parser<ExamplesOverride> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ExamplesOverride getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder