Class EntityFilter (2.17.6)

public final class EntityFilter extends GeneratedMessageV3 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

Static Fields

KINDS_FIELD_NUMBER

public static final int KINDS_FIELD_NUMBER
Field Value
TypeDescription
int

NAMESPACE_IDS_FIELD_NUMBER

public static final int NAMESPACE_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EntityFilter getDefaultInstance()
Returns
TypeDescription
EntityFilter

getDescriptor()

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

newBuilder()

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

newBuilder(EntityFilter prototype)

public static EntityFilter.Builder newBuilder(EntityFilter prototype)
Parameter
NameDescription
prototypeEntityFilter
Returns
TypeDescription
EntityFilter.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public EntityFilter getDefaultInstanceForType()
Returns
TypeDescription
EntityFilter

getKinds(int index)

public String getKinds(int index)

If empty, then this represents all kinds.

repeated string kinds = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
int

The count of kinds.

getKindsList()

public ProtocolStringList getKindsList()

If empty, then this represents all kinds.

repeated string kinds = 1;

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the namespaceIds.

getParserForType()

public Parser<EntityFilter> getParserForType()
Returns
TypeDescription
Parser<EntityFilter>
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 EntityFilter.Builder newBuilderForType()
Returns
TypeDescription
EntityFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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