Class CreateCryptoKeyRequest.Builder (2.38.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateCryptoKeyRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateCryptoKeyRequest.Builder
Overrides

build()

public CreateCryptoKeyRequest build()
Returns
TypeDescription
CreateCryptoKeyRequest

buildPartial()

public CreateCryptoKeyRequest buildPartial()
Returns
TypeDescription
CreateCryptoKeyRequest

clear()

public CreateCryptoKeyRequest.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
CreateCryptoKeyRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateCryptoKeyRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateCryptoKeyRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateCryptoKeyRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
CreateCryptoKeyRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CreateCryptoKeyRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateCryptoKeyRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
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.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueCryptoKey
Returns
TypeDescription
CreateCryptoKeyRequest.Builder

mergeFrom(CreateCryptoKeyRequest other)

public CreateCryptoKeyRequest.Builder mergeFrom(CreateCryptoKeyRequest other)
Parameter
NameDescription
otherCreateCryptoKeyRequest
Returns
TypeDescription
CreateCryptoKeyRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateCryptoKeyRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCryptoKeyRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateCryptoKeyRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CreateCryptoKeyRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateCryptoKeyRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueCryptoKey
Returns
TypeDescription
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
NameDescription
builderForValueCryptoKey.Builder
Returns
TypeDescription
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
NameDescription
valueString

The cryptoKeyId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for cryptoKeyId to set.

Returns
TypeDescription
CreateCryptoKeyRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateCryptoKeyRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The skipInitialVersionCreation to set.

Returns
TypeDescription
CreateCryptoKeyRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateCryptoKeyRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateCryptoKeyRequest.Builder
Overrides