- 3.82.0 (latest)
 - 3.80.0
 - 3.79.0
 - 3.78.0
 - 3.77.0
 - 3.76.0
 - 3.74.0
 - 3.72.0
 - 3.71.0
 - 3.68.0
 - 3.67.0
 - 3.66.0
 - 3.64.0
 - 3.63.0
 - 3.62.0
 - 3.61.0
 - 3.60.0
 - 3.59.0
 - 3.58.0
 - 3.57.0
 - 3.56.0
 - 3.55.0
 - 3.53.0
 - 3.52.0
 - 3.51.0
 - 3.50.0
 - 3.49.0
 - 3.48.0
 - 3.47.0
 - 3.46.0
 - 3.45.0
 - 3.44.0
 - 3.43.0
 - 3.41.0
 - 3.40.0
 - 3.39.0
 - 3.38.0
 - 3.37.0
 - 3.36.0
 - 3.35.0
 - 3.34.0
 - 3.33.0
 - 3.32.0
 - 3.31.0
 - 3.28.0
 - 3.27.0
 - 3.26.0
 - 3.25.0
 - 3.24.0
 - 3.23.0
 - 3.22.0
 - 3.21.0
 - 3.20.0
 - 3.19.0
 - 3.18.0
 - 3.17.0
 - 3.16.0
 - 3.15.0
 - 3.13.0
 - 3.12.0
 - 3.11.0
 - 3.10.0
 - 3.9.0
 - 3.8.0
 - 3.7.6
 - 3.6.7
 - 3.5.0
 - 3.4.0
 - 3.3.2
 - 3.2.1
 - 3.1.4
 
public static final class Key.Builder extends GeneratedMessageV3.Builder<Key.Builder> implements KeyOrBuilderA unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
 Protobuf type google.privacy.dlp.v2.Key
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Key.BuilderImplements
KeyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addAllPath(Iterable<? extends Key.PathElement> values)
public Key.Builder addAllPath(Iterable<? extends Key.PathElement> values)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
values | 
        Iterable<? extends com.google.privacy.dlp.v2.Key.PathElement> | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
addPath(Key.PathElement value)
public Key.Builder addPath(Key.PathElement value)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        Key.PathElement | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
addPath(Key.PathElement.Builder builderForValue)
public Key.Builder addPath(Key.PathElement.Builder builderForValue)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        Key.PathElement.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
addPath(int index, Key.PathElement value)
public Key.Builder addPath(int index, Key.PathElement value)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
value | 
        Key.PathElement | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
addPath(int index, Key.PathElement.Builder builderForValue)
public Key.Builder addPath(int index, Key.PathElement.Builder builderForValue)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
builderForValue | 
        Key.PathElement.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
addPathBuilder()
public Key.PathElement.Builder addPathBuilder()The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Returns | |
|---|---|
| Type | Description | 
Key.PathElement.Builder | 
        |
addPathBuilder(int index)
public Key.PathElement.Builder addPathBuilder(int index)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.PathElement.Builder | 
        |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Key.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
build()
public Key build()| Returns | |
|---|---|
| Type | Description | 
Key | 
        |
buildPartial()
public Key buildPartial()| Returns | |
|---|---|
| Type | Description | 
Key | 
        |
clear()
public Key.Builder clear()| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
clearField(Descriptors.FieldDescriptor field)
public Key.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
clearOneof(Descriptors.OneofDescriptor oneof)
public Key.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
clearPartitionId()
public Key.Builder clearPartitionId()Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
clearPath()
public Key.Builder clearPath()The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
clone()
public Key.Builder clone()| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
getDefaultInstanceForType()
public Key getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
Key | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getPartitionId()
public PartitionId getPartitionId()Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Returns | |
|---|---|
| Type | Description | 
PartitionId | 
        The partitionId.  | 
      
getPartitionIdBuilder()
public PartitionId.Builder getPartitionIdBuilder()Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Returns | |
|---|---|
| Type | Description | 
PartitionId.Builder | 
        |
getPartitionIdOrBuilder()
public PartitionIdOrBuilder getPartitionIdOrBuilder()Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Returns | |
|---|---|
| Type | Description | 
PartitionIdOrBuilder | 
        |
getPath(int index)
public Key.PathElement getPath(int index)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.PathElement | 
        |
getPathBuilder(int index)
public Key.PathElement.Builder getPathBuilder(int index)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.PathElement.Builder | 
        |
getPathBuilderList()
public List<Key.PathElement.Builder> getPathBuilderList()The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Returns | |
|---|---|
| Type | Description | 
List<Builder> | 
        |
getPathCount()
public int getPathCount()The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getPathList()
public List<Key.PathElement> getPathList()The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Returns | |
|---|---|
| Type | Description | 
List<PathElement> | 
        |
getPathOrBuilder(int index)
public Key.PathElementOrBuilder getPathOrBuilder(int index)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.PathElementOrBuilder | 
        |
getPathOrBuilderList()
public List<? extends Key.PathElementOrBuilder> getPathOrBuilderList()The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.privacy.dlp.v2.Key.PathElementOrBuilder> | 
        |
hasPartitionId()
public boolean hasPartitionId()Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the partitionId field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeFrom(Key other)
public Key.Builder mergeFrom(Key other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Key | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Key.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public Key.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
mergePartitionId(PartitionId value)
public Key.Builder mergePartitionId(PartitionId value)Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        PartitionId | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Key.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
removePath(int index)
public Key.Builder removePath(int index)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public Key.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setPartitionId(PartitionId value)
public Key.Builder setPartitionId(PartitionId value)Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        PartitionId | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setPartitionId(PartitionId.Builder builderForValue)
public Key.Builder setPartitionId(PartitionId.Builder builderForValue)Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
 .google.privacy.dlp.v2.PartitionId partition_id = 1;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        PartitionId.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setPath(int index, Key.PathElement value)
public Key.Builder setPath(int index, Key.PathElement value)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
value | 
        Key.PathElement | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setPath(int index, Key.PathElement.Builder builderForValue)
public Key.Builder setPath(int index, Key.PathElement.Builder builderForValue)The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors.
A path can never be empty, and a path can have at most 100 elements.
 repeated .google.privacy.dlp.v2.Key.PathElement path = 2;
| Parameters | |
|---|---|
| Name | Description | 
index | 
        int | 
      
builderForValue | 
        Key.PathElement.Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Key.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final Key.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
Key.Builder | 
        |