Class EntityFilter.Builder (2.17.6)

Version 2.17.6

• 2.25.1 (latest)
• 2.24.3
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public static final class EntityFilter.Builder extends GeneratedMessageV3.Builder<EntityFilter.Builder> implements EntityFilterOrBuilder

Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage:

Entire project: kinds=[], namespace_ids=[]

Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[]

Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=['']

Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']

The entire Baz namespace: kinds=[], namespace_ids=['Baz']

Protobuf type google.datastore.admin.v1.EntityFilter

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EntityFilter.Builder

Implements

EntityFilterOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllKinds(Iterable<String> values)

public EntityFilter.Builder addAllKinds(Iterable<String> values)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameter
Name	Description
values	Iterable<String> The kinds to add.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

addAllNamespaceIds(Iterable<String> values)

public EntityFilter.Builder addAllNamespaceIds(Iterable<String> values)

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Parameter
Name	Description
values	Iterable<String> The namespaceIds to add.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

addKinds(String value)

public EntityFilter.Builder addKinds(String value)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameter
Name	Description
value	String The kinds to add.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

addKindsBytes(ByteString value)

public EntityFilter.Builder addKindsBytes(ByteString value)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameter
Name	Description
value	ByteString The bytes of the kinds to add.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

addNamespaceIds(String value)

public EntityFilter.Builder addNamespaceIds(String value)

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Parameter
Name	Description
value	String The namespaceIds to add.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

addNamespaceIdsBytes(ByteString value)

public EntityFilter.Builder addNamespaceIdsBytes(ByteString value)

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Parameter
Name	Description
value	ByteString The bytes of the namespaceIds to add.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EntityFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public EntityFilter build()

Returns
Type	Description
EntityFilter

buildPartial()

public EntityFilter buildPartial()

Returns
Type	Description
EntityFilter

clear()

public EntityFilter.Builder clear()

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public EntityFilter.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearKinds()

public EntityFilter.Builder clearKinds()

If empty, then this represents all kinds.

repeated string kinds = 1;

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

clearNamespaceIds()

public EntityFilter.Builder clearNamespaceIds()

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EntityFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public EntityFilter.Builder clone()

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public EntityFilter getDefaultInstanceForType()

Returns
Type	Description
EntityFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getKinds(int index)

public String getKinds(int index)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The kinds at the given index.

getKindsBytes(int index)

public ByteString getKindsBytes(int index)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the kinds at the given index.

getKindsCount()

public int getKindsCount()

If empty, then this represents all kinds.

repeated string kinds = 1;

Returns
Type	Description
int	The count of kinds.

getKindsList()

public ProtocolStringList getKindsList()

If empty, then this represents all kinds.

repeated string kinds = 1;

Returns
Type	Description
ProtocolStringList	A list containing the kinds.

getNamespaceIds(int index)

public String getNamespaceIds(int index)

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The namespaceIds at the given index.

getNamespaceIdsBytes(int index)

public ByteString getNamespaceIdsBytes(int index)

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the namespaceIds at the given index.

getNamespaceIdsCount()

public int getNamespaceIdsCount()

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Returns
Type	Description
int	The count of namespaceIds.

getNamespaceIdsList()

public ProtocolStringList getNamespaceIdsList()

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Returns
Type	Description
ProtocolStringList	A list containing the namespaceIds.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(EntityFilter other)

public EntityFilter.Builder mergeFrom(EntityFilter other)

Parameter
Name	Description
other	EntityFilter

Returns
Type	Description
EntityFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EntityFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EntityFilter.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public EntityFilter.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
EntityFilter.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EntityFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public EntityFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setKinds(int index, String value)

public EntityFilter.Builder setKinds(int index, String value)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameters
Name	Description
index	int The index to set the value at.
value	String The kinds to set.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

setNamespaceIds(int index, String value)

public EntityFilter.Builder setNamespaceIds(int index, String value)

An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces.

An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 2;

Parameters
Name	Description
index	int The index to set the value at.
value	String The namespaceIds to set.

Returns
Type	Description
EntityFilter.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final EntityFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EntityFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)