Class Key (3.77.0)

  public 
  
 final 
  
 class 
 Key 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 KeyOrBuilder 
 

A 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

Implements

KeyOrBuilder

Static Fields

PARTITION_ID_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PARTITION_ID_FIELD_NUMBER 
 
Field Value
Type
Description
int

PATH_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PATH_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Key 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description
Key

getDescriptor()

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

newBuilder()

  public 
  
 static 
  
 Key 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Key prototype)

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

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Key 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Key
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Key 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Key
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Key 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Key
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<Key> 
  
 parser 
 () 
 
Returns
Type
Description
Parser < Key >

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getDefaultInstanceForType()

  public 
  
 Key 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description
Key

getParserForType()

  public 
  
 Parser<Key> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Parser < Key >
Overrides

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

The partitionId.

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

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

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

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

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 >

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

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

Whether the partitionId field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 Key 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

  public 
  
 Key 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: