Class ExamplesOverride (3.25.0)

public final class ExamplesOverride extends GeneratedMessageV3 implements ExamplesOverrideOrBuilder

Overrides for example-based explanations.

Protobuf type google.cloud.aiplatform.v1beta1.ExamplesOverride

Static Fields

CROWDING_COUNT_FIELD_NUMBER

public static final int CROWDING_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_FORMAT_FIELD_NUMBER

public static final int DATA_FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

RESTRICTIONS_FIELD_NUMBER

public static final int RESTRICTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_EMBEDDINGS_FIELD_NUMBER

public static final int RETURN_EMBEDDINGS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExamplesOverride getDefaultInstance()
Returns
TypeDescription
ExamplesOverride

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExamplesOverride.Builder newBuilder()
Returns
TypeDescription
ExamplesOverride.Builder

newBuilder(ExamplesOverride prototype)

public static ExamplesOverride.Builder newBuilder(ExamplesOverride prototype)
Parameter
NameDescription
prototypeExamplesOverride
Returns
TypeDescription
ExamplesOverride.Builder

parseDelimitedFrom(InputStream input)

public static ExamplesOverride parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExamplesOverride parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExamplesOverride parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExamplesOverride parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExamplesOverride parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExamplesOverride parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExamplesOverride parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExamplesOverride> parser()
Returns
TypeDescription
Parser<ExamplesOverride>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCrowdingCount()

public int getCrowdingCount()

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

int32 crowding_count = 2;

Returns
TypeDescription
int

The crowdingCount.

getDataFormat()

public ExamplesOverride.DataFormat getDataFormat()

The format of the data being provided with each call.

.google.cloud.aiplatform.v1beta1.ExamplesOverride.DataFormat data_format = 5;

Returns
TypeDescription
ExamplesOverride.DataFormat

The dataFormat.

getDataFormatValue()

public int getDataFormatValue()

The format of the data being provided with each call.

.google.cloud.aiplatform.v1beta1.ExamplesOverride.DataFormat data_format = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ExamplesOverride getDefaultInstanceForType()
Returns
TypeDescription
ExamplesOverride

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
TypeDescription
int

The neighborCount.

getParserForType()

public Parser<ExamplesOverride> getParserForType()
Returns
TypeDescription
Parser<ExamplesOverride>
Overrides

getRestrictions(int index)

public ExamplesRestrictionsNamespace getRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespace

getRestrictionsCount()

public int getRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
TypeDescription
int

getRestrictionsList()

public List<ExamplesRestrictionsNamespace> getRestrictionsList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
TypeDescription
List<ExamplesRestrictionsNamespace>

getRestrictionsOrBuilder(int index)

public ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespaceOrBuilder

getRestrictionsOrBuilderList()

public List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespaceOrBuilder>

getReturnEmbeddings()

public boolean getReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
TypeDescription
boolean

The returnEmbeddings.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExamplesOverride.Builder newBuilderForType()
Returns
TypeDescription
ExamplesOverride.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExamplesOverride.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExamplesOverride.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExamplesOverride.Builder toBuilder()
Returns
TypeDescription
ExamplesOverride.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException