Class IndexDatapoint.Restriction (3.31.0)

public static final class IndexDatapoint.Restriction extends GeneratedMessageV3 implements IndexDatapoint.RestrictionOrBuilder

Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).

Protobuf type google.cloud.aiplatform.v1.IndexDatapoint.Restriction

Static Fields

ALLOW_LIST_FIELD_NUMBER

public static final int ALLOW_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

DENY_LIST_FIELD_NUMBER

public static final int DENY_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

NAMESPACE_FIELD_NUMBER

public static final int NAMESPACE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static IndexDatapoint.Restriction getDefaultInstance()
Returns
TypeDescription
IndexDatapoint.Restriction

getDescriptor()

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

newBuilder()

public static IndexDatapoint.Restriction.Builder newBuilder()
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

newBuilder(IndexDatapoint.Restriction prototype)

public static IndexDatapoint.Restriction.Builder newBuilder(IndexDatapoint.Restriction prototype)
Parameter
NameDescription
prototypeIndexDatapoint.Restriction
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

parseDelimitedFrom(InputStream input)

public static IndexDatapoint.Restriction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexDatapoint.Restriction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static IndexDatapoint.Restriction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
IndexDatapoint.Restriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static IndexDatapoint.Restriction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
IndexDatapoint.Restriction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static IndexDatapoint.Restriction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexDatapoint.Restriction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static IndexDatapoint.Restriction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
IndexDatapoint.Restriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<IndexDatapoint.Restriction> parser()
Returns
TypeDescription
Parser<Restriction>

Methods

equals(Object obj)

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

getAllowList(int index)

public String getAllowList(int index)

The attributes to allow in this namespace. e.g.: 'red'

repeated string allow_list = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowList at the given index.

getAllowListBytes(int index)

public ByteString getAllowListBytes(int index)

The attributes to allow in this namespace. e.g.: 'red'

repeated string allow_list = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowList at the given index.

getAllowListCount()

public int getAllowListCount()

The attributes to allow in this namespace. e.g.: 'red'

repeated string allow_list = 2;

Returns
TypeDescription
int

The count of allowList.

getAllowListList()

public ProtocolStringList getAllowListList()

The attributes to allow in this namespace. e.g.: 'red'

repeated string allow_list = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the allowList.

getDefaultInstanceForType()

public IndexDatapoint.Restriction getDefaultInstanceForType()
Returns
TypeDescription
IndexDatapoint.Restriction

getDenyList(int index)

public String getDenyList(int index)

The attributes to deny in this namespace. e.g.: 'blue'

repeated string deny_list = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The denyList at the given index.

getDenyListBytes(int index)

public ByteString getDenyListBytes(int index)

The attributes to deny in this namespace. e.g.: 'blue'

repeated string deny_list = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the denyList at the given index.

getDenyListCount()

public int getDenyListCount()

The attributes to deny in this namespace. e.g.: 'blue'

repeated string deny_list = 3;

Returns
TypeDescription
int

The count of denyList.

getDenyListList()

public ProtocolStringList getDenyListList()

The attributes to deny in this namespace. e.g.: 'blue'

repeated string deny_list = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the denyList.

getNamespace()

public String getNamespace()

The namespace of this restriction. e.g.: color.

string namespace = 1;

Returns
TypeDescription
String

The namespace.

getNamespaceBytes()

public ByteString getNamespaceBytes()

The namespace of this restriction. e.g.: color.

string namespace = 1;

Returns
TypeDescription
ByteString

The bytes for namespace.

getParserForType()

public Parser<IndexDatapoint.Restriction> getParserForType()
Returns
TypeDescription
Parser<Restriction>
Overrides

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 IndexDatapoint.Restriction.Builder newBuilderForType()
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public IndexDatapoint.Restriction.Builder toBuilder()
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

writeTo(CodedOutputStream output)

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