Class CreateCryptoKeyRequest.Builder (2.51.0)

public static final class CreateCryptoKeyRequest.Builder extends GeneratedMessageV3.Builder<CreateCryptoKeyRequest.Builder> implements CreateCryptoKeyRequestOrBuilder

Request message for KeyManagementService.CreateCryptoKey.

Protobuf type google.cloud.kms.v1.CreateCryptoKeyRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateCryptoKeyRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

build()

public CreateCryptoKeyRequest build()
Returns
Type Description
CreateCryptoKeyRequest

buildPartial()

public CreateCryptoKeyRequest buildPartial()
Returns
Type Description
CreateCryptoKeyRequest

clear()

public CreateCryptoKeyRequest.Builder clear()
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

clearCryptoKey()

public CreateCryptoKeyRequest.Builder clearCryptoKey()

Required. A CryptoKey with initial field values.

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

Returns
Type Description
CreateCryptoKeyRequest.Builder

clearCryptoKeyId()

public CreateCryptoKeyRequest.Builder clearCryptoKeyId()

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
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateCryptoKeyRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateCryptoKeyRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

clearParent()

public CreateCryptoKeyRequest.Builder clearParent()

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

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

Returns
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

clearSkipInitialVersionCreation()

public CreateCryptoKeyRequest.Builder clearSkipInitialVersionCreation()

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
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

clone()

public CreateCryptoKeyRequest.Builder clone()
Returns
Type Description
CreateCryptoKeyRequest.Builder
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
Type Description
CryptoKey

The cryptoKey.

getCryptoKeyBuilder()

public CryptoKey.Builder getCryptoKeyBuilder()

Required. A CryptoKey with initial field values.

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

Returns
Type Description
CryptoKey.Builder

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
Type Description
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
Type Description
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
Type Description
CryptoKeyOrBuilder

getDefaultInstanceForType()

public CreateCryptoKeyRequest getDefaultInstanceForType()
Returns
Type Description
CreateCryptoKeyRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
ByteString

The bytes for parent.

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
Type Description
boolean

The skipInitialVersionCreation.

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
Type Description
boolean

Whether the cryptoKey field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCryptoKey(CryptoKey value)

public CreateCryptoKeyRequest.Builder mergeCryptoKey(CryptoKey value)

Required. A CryptoKey with initial field values.

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

Parameter
Name Description
value CryptoKey
Returns
Type Description
CreateCryptoKeyRequest.Builder

mergeFrom(CreateCryptoKeyRequest other)

public CreateCryptoKeyRequest.Builder mergeFrom(CreateCryptoKeyRequest other)
Parameter
Name Description
other CreateCryptoKeyRequest
Returns
Type Description
CreateCryptoKeyRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateCryptoKeyRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateCryptoKeyRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateCryptoKeyRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

setCryptoKey(CryptoKey value)

public CreateCryptoKeyRequest.Builder setCryptoKey(CryptoKey value)

Required. A CryptoKey with initial field values.

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

Parameter
Name Description
value CryptoKey
Returns
Type Description
CreateCryptoKeyRequest.Builder

setCryptoKey(CryptoKey.Builder builderForValue)

public CreateCryptoKeyRequest.Builder setCryptoKey(CryptoKey.Builder builderForValue)

Required. A CryptoKey with initial field values.

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

Parameter
Name Description
builderForValue CryptoKey.Builder
Returns
Type Description
CreateCryptoKeyRequest.Builder

setCryptoKeyId(String value)

public CreateCryptoKeyRequest.Builder setCryptoKeyId(String value)

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];

Parameter
Name Description
value String

The cryptoKeyId to set.

Returns
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

setCryptoKeyIdBytes(ByteString value)

public CreateCryptoKeyRequest.Builder setCryptoKeyIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for cryptoKeyId to set.

Returns
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateCryptoKeyRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

setParent(String value)

public CreateCryptoKeyRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateCryptoKeyRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateCryptoKeyRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides

setSkipInitialVersionCreation(boolean value)

public CreateCryptoKeyRequest.Builder setSkipInitialVersionCreation(boolean value)

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;

Parameter
Name Description
value boolean

The skipInitialVersionCreation to set.

Returns
Type Description
CreateCryptoKeyRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateCryptoKeyRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateCryptoKeyRequest.Builder
Overrides