Keyset.Builder

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
- - com.google.protobuf.GeneratedMessageLite.Builder<Keyset,Keyset.Builder>
  - - com.google.crypto.tink.proto.Keyset.Builder

All Implemented Interfaces:: KeysetOrBuilder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable

Enclosing class:: Keyset

public static final class Keyset.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<Keyset,Keyset.Builder>
implements KeysetOrBuilder

 A Tink user works usually not with single keys, but with keysets,
 to enable key rotation.  The keys in a keyset can belong to different
 implementations/key types, but must all implement the same primitive.
 Any given keyset (and any given key) can be used for one primitive only.

Protobuf type google.crypto.tink.Keyset

Field Summary
- Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
  instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Keyset.Builder`	`addAllKey(Iterable<? extends Keyset.Key> values)` Actual keys in the Keyset.
`Keyset.Builder`	`addKey(int index, Keyset.Key.Builder builderForValue)` Actual keys in the Keyset.
`Keyset.Builder`	`addKey(int index, Keyset.Key value)` Actual keys in the Keyset.
`Keyset.Builder`	`addKey(Keyset.Key.Builder builderForValue)` Actual keys in the Keyset.
`Keyset.Builder`	`addKey(Keyset.Key value)` Actual keys in the Keyset.
`Keyset.Builder`	`clearKey()` Actual keys in the Keyset.
`Keyset.Builder`	`clearPrimaryKeyId()` Identifies key used to generate new crypto data (encrypt, sign).
`Keyset.Key`	`getKey(int index)` Actual keys in the Keyset.
`int`	`getKeyCount()` Actual keys in the Keyset.
`List<Keyset.Key>`	`getKeyList()` Actual keys in the Keyset.
`int`	`getPrimaryKeyId()` Identifies key used to generate new crypto data (encrypt, sign).
`Keyset.Builder`	`removeKey(int index)` Actual keys in the Keyset.
`Keyset.Builder`	`setKey(int index, Keyset.Key.Builder builderForValue)` Actual keys in the Keyset.
`Keyset.Builder`	`setKey(int index, Keyset.Key value)` Actual keys in the Keyset.
`Keyset.Builder`	`setPrimaryKeyId(int value)` Identifies key used to generate new crypto data (encrypt, sign).

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized

Method Detail

getPrimaryKeyId
```
public int getPrimaryKeyId()
```
```
 Identifies key used to generate new crypto data (encrypt, sign).
 Required.
 
```
uint32 primary_key_id = 1;
Specified by:

getPrimaryKeyId in interface KeysetOrBuilder

Returns:

The primaryKeyId.

setPrimaryKeyId

public Keyset.Builder setPrimaryKeyId(int value)

 Identifies key used to generate new crypto data (encrypt, sign).
 Required.

uint32 primary_key_id = 1;

Parameters:: value - The primaryKeyId to set.
Returns:: This builder for chaining.

clearPrimaryKeyId

public Keyset.Builder clearPrimaryKeyId()

 Identifies key used to generate new crypto data (encrypt, sign).
 Required.

uint32 primary_key_id = 1;

Returns:: This builder for chaining.

getKeyList
```
public List<Keyset.Key> getKeyList()
```
```
 Actual keys in the Keyset.
 Required.
 
```
repeated .google.crypto.tink.Keyset.Key key = 2;
Specified by:

getKeyList in interface KeysetOrBuilder

getKeyCount
```
public int getKeyCount()
```
```
 Actual keys in the Keyset.
 Required.
 
```
repeated .google.crypto.tink.Keyset.Key key = 2;
Specified by:

getKeyCount in interface KeysetOrBuilder

getKey
```
public Keyset.Key getKey(int index)
```
```
 Actual keys in the Keyset.
 Required.
 
```
repeated .google.crypto.tink.Keyset.Key key = 2;
Specified by:

getKey in interface KeysetOrBuilder