Class IndexDatapoint.Restriction.Builder (3.32.0)

public static final class IndexDatapoint.Restriction.Builder extends GeneratedMessageV3.Builder<IndexDatapoint.Restriction.Builder> 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 Methods

getDescriptor()

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

Methods

addAllAllowList(Iterable<String> values)

public IndexDatapoint.Restriction.Builder addAllAllowList(Iterable<String> values)

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

repeated string allow_list = 2;

Parameter
NameDescription
valuesIterable<String>

The allowList to add.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

addAllDenyList(Iterable<String> values)

public IndexDatapoint.Restriction.Builder addAllDenyList(Iterable<String> values)

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

repeated string deny_list = 3;

Parameter
NameDescription
valuesIterable<String>

The denyList to add.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

addAllowList(String value)

public IndexDatapoint.Restriction.Builder addAllowList(String value)

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

repeated string allow_list = 2;

Parameter
NameDescription
valueString

The allowList to add.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

addAllowListBytes(ByteString value)

public IndexDatapoint.Restriction.Builder addAllowListBytes(ByteString value)

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

repeated string allow_list = 2;

Parameter
NameDescription
valueByteString

The bytes of the allowList to add.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

addDenyList(String value)

public IndexDatapoint.Restriction.Builder addDenyList(String value)

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

repeated string deny_list = 3;

Parameter
NameDescription
valueString

The denyList to add.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

addDenyListBytes(ByteString value)

public IndexDatapoint.Restriction.Builder addDenyListBytes(ByteString value)

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

repeated string deny_list = 3;

Parameter
NameDescription
valueByteString

The bytes of the denyList to add.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public IndexDatapoint.Restriction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

build()

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

buildPartial()

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

clear()

public IndexDatapoint.Restriction.Builder clear()
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

clearAllowList()

public IndexDatapoint.Restriction.Builder clearAllowList()

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

repeated string allow_list = 2;

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

clearDenyList()

public IndexDatapoint.Restriction.Builder clearDenyList()

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

repeated string deny_list = 3;

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public IndexDatapoint.Restriction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

clearNamespace()

public IndexDatapoint.Restriction.Builder clearNamespace()

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

string namespace = 1;

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public IndexDatapoint.Restriction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(IndexDatapoint.Restriction other)

public IndexDatapoint.Restriction.Builder mergeFrom(IndexDatapoint.Restriction other)
Parameter
NameDescription
otherIndexDatapoint.Restriction
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IndexDatapoint.Restriction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public IndexDatapoint.Restriction.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.Restriction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

setAllowList(int index, String value)

public IndexDatapoint.Restriction.Builder setAllowList(int index, String value)

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

repeated string allow_list = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The allowList to set.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

setDenyList(int index, String value)

public IndexDatapoint.Restriction.Builder setDenyList(int index, String value)

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

repeated string deny_list = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The denyList to set.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public IndexDatapoint.Restriction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

setNamespace(String value)

public IndexDatapoint.Restriction.Builder setNamespace(String value)

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

string namespace = 1;

Parameter
NameDescription
valueString

The namespace to set.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

setNamespaceBytes(ByteString value)

public IndexDatapoint.Restriction.Builder setNamespaceBytes(ByteString value)

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

string namespace = 1;

Parameter
NameDescription
valueByteString

The bytes for namespace to set.

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public IndexDatapoint.Restriction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.Restriction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
IndexDatapoint.Restriction.Builder
Overrides