Class CreateCryptoKeyRequest

public final class CreateCryptoKeyRequest extends GeneratedMessageV3 implements CreateCryptoKeyRequestOrBuilder

Request message for KeyManagementService.CreateCryptoKey.

Protobuf type google.cloud.kms.v1.CreateCryptoKeyRequest

Fields

CRYPTO_KEY_FIELD_NUMBER

public static final int CRYPTO_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

CRYPTO_KEY_ID_FIELD_NUMBER

public static final int CRYPTO_KEY_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

SKIP_INITIAL_VERSION_CREATION_FIELD_NUMBER

public static final int SKIP_INITIAL_VERSION_CREATION_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

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

getCryptoKey()

public CryptoKey getCryptoKey()

Required. A CryptoKey with initial field values.

.google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CryptoKey

The cryptoKey.

getCryptoKeyId()

public String getCryptoKeyId()

Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}

string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The cryptoKeyId.

getCryptoKeyIdBytes()

public ByteString getCryptoKeyIdBytes()

Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}

string crypto_key_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for cryptoKeyId.

getCryptoKeyOrBuilder()

public CryptoKeyOrBuilder getCryptoKeyOrBuilder()

Required. A CryptoKey with initial field values.

.google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CryptoKeyOrBuilder

getDefaultInstance()

public static CreateCryptoKeyRequest getDefaultInstance()
Returns
TypeDescription
CreateCryptoKeyRequest

getDefaultInstanceForType()

public CreateCryptoKeyRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateCryptoKeyRequest

getDescriptor()

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

getParent()

public String getParent()

Required. The name of the KeyRing associated with the CryptoKeys.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the KeyRing associated with the CryptoKeys.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateCryptoKeyRequest> getParserForType()
Returns
TypeDescription
Parser<CreateCryptoKeyRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSkipInitialVersionCreation()

public boolean getSkipInitialVersionCreation()

If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.

bool skip_initial_version_creation = 5;

Returns
TypeDescription
boolean

The skipInitialVersionCreation.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCryptoKey()

public boolean hasCryptoKey()

Required. A CryptoKey with initial field values.

.google.cloud.kms.v1.CryptoKey crypto_key = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the cryptoKey field is set.

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

newBuilder()

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

newBuilder(CreateCryptoKeyRequest prototype)

public static CreateCryptoKeyRequest.Builder newBuilder(CreateCryptoKeyRequest prototype)
Parameter
NameDescription
prototypeCreateCryptoKeyRequest
Returns
TypeDescription
CreateCryptoKeyRequest.Builder

newBuilderForType()

public CreateCryptoKeyRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateCryptoKeyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

toBuilder()

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

writeTo(CodedOutputStream output)

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