Class IndexDatapoint.Restriction (3.46.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
Type Description
int

DENY_LIST_FIELD_NUMBER

public static final int DENY_LIST_FIELD_NUMBER
Field Value
Type Description
int

NAMESPACE_FIELD_NUMBER

public static final int NAMESPACE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IndexDatapoint.Restriction getDefaultInstance()
Returns
Type Description
IndexDatapoint.Restriction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static IndexDatapoint.Restriction.Builder newBuilder()
Returns
Type Description
IndexDatapoint.Restriction.Builder

newBuilder(IndexDatapoint.Restriction prototype)

public static IndexDatapoint.Restriction.Builder newBuilder(IndexDatapoint.Restriction prototype)
Parameter
Name Description
prototype IndexDatapoint.Restriction
Returns
Type Description
IndexDatapoint.Restriction.Builder

parseDelimitedFrom(InputStream input)

public static IndexDatapoint.Restriction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.Restriction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IndexDatapoint.Restriction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.Restriction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexDatapoint.Restriction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.Restriction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexDatapoint.Restriction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.Restriction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IndexDatapoint.Restriction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.Restriction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IndexDatapoint.Restriction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.Restriction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.Restriction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the allowList.

getDefaultInstanceForType()

public IndexDatapoint.Restriction getDefaultInstanceForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the denyList.

getNamespace()

public String getNamespace()

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

string namespace = 1;

Returns
Type Description
String

The namespace.

getNamespaceBytes()

public ByteString getNamespaceBytes()

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

string namespace = 1;

Returns
Type Description
ByteString

The bytes for namespace.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IndexDatapoint.Restriction.Builder newBuilderForType()
Returns
Type Description
IndexDatapoint.Restriction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexDatapoint.Restriction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IndexDatapoint.Restriction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IndexDatapoint.Restriction.Builder toBuilder()
Returns
Type Description
IndexDatapoint.Restriction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException