Class GenerateWrappingKeyRpcCommand
-
- All Implemented Interfaces:
-
java.io.Externalizable
,java.io.Serializable
,java.lang.Comparable
,org.apache.avro.generic.GenericContainer
,org.apache.avro.generic.GenericRecord
,org.apache.avro.generic.IndexedRecord
,org.apache.avro.specific.SpecificRecord
public class GenerateWrappingKeyRpcCommand extends SpecificRecordBase implements SpecificRecord
Request to generate new wrapped key (fresh key) pair.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
GenerateWrappingKeyRpcCommand.Builder
RecordBuilder for GenerateWrappingKeyRpcCommand instances.
-
Field Summary
Fields Modifier and Type Field Description public final static Schema
SCHEMA$
public String
hsmId
public String
masterKeyAlias
public boolean
failIfExists
public KeyValuePairList
context
-
Constructor Summary
Constructors Constructor Description GenerateWrappingKeyRpcCommand()
Default constructor. GenerateWrappingKeyRpcCommand(String hsmId, String masterKeyAlias, Boolean failIfExists, KeyValuePairList context)
All-args constructor.
-
Method Summary
Modifier and Type Method Description String
getHsmId()
Gets the value of the 'hsmId' field. void
setHsmId(String value)
Sets the value of the 'hsmId' field. String
getMasterKeyAlias()
Gets the value of the 'masterKeyAlias' field. void
setMasterKeyAlias(String value)
Sets the value of the 'masterKeyAlias' field. boolean
getFailIfExists()
Gets the value of the 'failIfExists' field. void
setFailIfExists(boolean value)
Sets the value of the 'failIfExists' field. KeyValuePairList
getContext()
Gets the value of the 'context' field. void
setContext(KeyValuePairList value)
Sets the value of the 'context' field. static Schema
getClassSchema()
static BinaryMessageEncoder<GenerateWrappingKeyRpcCommand>
getEncoder()
Return the BinaryMessageEncoder instance used by this class. static BinaryMessageDecoder<GenerateWrappingKeyRpcCommand>
getDecoder()
Return the BinaryMessageDecoder instance used by this class. static BinaryMessageDecoder<GenerateWrappingKeyRpcCommand>
createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore. ByteBuffer
toByteBuffer()
Serializes this GenerateWrappingKeyRpcCommand to a ByteBuffer. static GenerateWrappingKeyRpcCommand
fromByteBuffer(ByteBuffer b)
Deserializes a GenerateWrappingKeyRpcCommand from a ByteBuffer. SpecificData
getSpecificData()
Schema
getSchema()
Object
get(int field$)
void
put(int field$, Object value$)
static GenerateWrappingKeyRpcCommand.Builder
newBuilder()
Creates a new GenerateWrappingKeyRpcCommand RecordBuilder. static GenerateWrappingKeyRpcCommand.Builder
newBuilder(GenerateWrappingKeyRpcCommand.Builder other)
Creates a new GenerateWrappingKeyRpcCommand RecordBuilder by copying an existing Builder. static GenerateWrappingKeyRpcCommand.Builder
newBuilder(GenerateWrappingKeyRpcCommand other)
Creates a new GenerateWrappingKeyRpcCommand RecordBuilder by copying an existing GenerateWrappingKeyRpcCommand instance. void
writeExternal(ObjectOutput out)
void
readExternal(ObjectInput in)
void
customEncode(Encoder out)
void
customDecode(ResolvingDecoder in)
-
Methods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, equals, getConversion, hashCode, toString
-
Methods inherited from class org.apache.avro.generic.GenericRecord
hasField
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
GenerateWrappingKeyRpcCommand
GenerateWrappingKeyRpcCommand()
Default constructor.
-
GenerateWrappingKeyRpcCommand
GenerateWrappingKeyRpcCommand(String hsmId, String masterKeyAlias, Boolean failIfExists, KeyValuePairList context)
All-args constructor.- Parameters:
hsmId
- The HSM id which the key is generated in.masterKeyAlias
- The alias of the key to be used as a wrapping key.failIfExists
- A flag indicating whether the method should fail if a key already exists under the provided alias or return normally without overriding the key.context
- The optional key/value operation specific context.
-
-
Method Detail
-
setHsmId
void setHsmId(String value)
Sets the value of the 'hsmId' field. The HSM id which the key is generated in.
- Parameters:
value
- the value to set.
-
getMasterKeyAlias
String getMasterKeyAlias()
Gets the value of the 'masterKeyAlias' field.
-
setMasterKeyAlias
void setMasterKeyAlias(String value)
Sets the value of the 'masterKeyAlias' field. The alias of the key to be used as a wrapping key.
- Parameters:
value
- the value to set.
-
getFailIfExists
boolean getFailIfExists()
Gets the value of the 'failIfExists' field.
-
setFailIfExists
void setFailIfExists(boolean value)
Sets the value of the 'failIfExists' field. A flag indicating whether the method should fail if a key already exists under the provided alias or return normally without overriding the key.
- Parameters:
value
- the value to set.
-
getContext
KeyValuePairList getContext()
Gets the value of the 'context' field.
-
setContext
void setContext(KeyValuePairList value)
Sets the value of the 'context' field. The optional key/value operation specific context.
- Parameters:
value
- the value to set.
-
getClassSchema
static Schema getClassSchema()
-
getEncoder
static BinaryMessageEncoder<GenerateWrappingKeyRpcCommand> getEncoder()
Return the BinaryMessageEncoder instance used by this class.
-
getDecoder
static BinaryMessageDecoder<GenerateWrappingKeyRpcCommand> getDecoder()
Return the BinaryMessageDecoder instance used by this class.
-
createDecoder
static BinaryMessageDecoder<GenerateWrappingKeyRpcCommand> createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
- Parameters:
resolver
- a SchemaStore used to find schemas by fingerprint
-
toByteBuffer
ByteBuffer toByteBuffer()
Serializes this GenerateWrappingKeyRpcCommand to a ByteBuffer.
-
fromByteBuffer
static GenerateWrappingKeyRpcCommand fromByteBuffer(ByteBuffer b)
Deserializes a GenerateWrappingKeyRpcCommand from a ByteBuffer.
- Parameters:
b
- a byte buffer holding serialized data for an instance of this class
-
getSpecificData
SpecificData getSpecificData()
-
getSchema
Schema getSchema()
-
newBuilder
static GenerateWrappingKeyRpcCommand.Builder newBuilder()
Creates a new GenerateWrappingKeyRpcCommand RecordBuilder.
-
newBuilder
static GenerateWrappingKeyRpcCommand.Builder newBuilder(GenerateWrappingKeyRpcCommand.Builder other)
Creates a new GenerateWrappingKeyRpcCommand RecordBuilder by copying an existing Builder.
- Parameters:
other
- The existing builder to copy.
-
newBuilder
static GenerateWrappingKeyRpcCommand.Builder newBuilder(GenerateWrappingKeyRpcCommand other)
Creates a new GenerateWrappingKeyRpcCommand RecordBuilder by copying an existing GenerateWrappingKeyRpcCommand instance.
- Parameters:
other
- The existing instance to copy.
-
writeExternal
void writeExternal(ObjectOutput out)
-
readExternal
void readExternal(ObjectInput in)
-
customEncode
void customEncode(Encoder out)
-
customDecode
void customDecode(ResolvingDecoder in)
-
-
-
-