Class CreateKeyOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.CreateKeyOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateKeyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createKey options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateKeyOptions.Builder	Builder.
static interface	CreateKeyOptions.Type	The crypto-system for this key.

Method Summary

Modifier and Type	Method	Description
String	name()	Gets the name.
CreateKeyOptions.Builder	newBuilder()	New builder.
String	publicKey()	Gets the publicKey.
ResourceGroupIdentity	resourceGroup()	Gets the resourceGroup.
String	type()	Gets the type.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public CreateKeyOptions.Builder newBuilder()

New builder.

Returns:

a CreateKeyOptions builder

publicKey

public String publicKey()

Gets the publicKey. The public SSH key to use, in OpenSSH format (consisting of three space-separated fields: the algorithm name, base64-encoded key value, and a comment). The algorithm and comment fields may be omitted, as only the key field is used. The key field must not match another key in the region. Keys of type `rsa` must be 2048 or 4096 bits in length (4096 is recommended). Keys of type `ed25519` must be 256 bits in length.

Returns:

the publicKey

name

public String name()

Gets the name. The name for this key. The name must not be used by another key in the region. If unspecified, the name will be a hyphenated list of randomly-selected words.

Returns:

the name

resourceGroup

public ResourceGroupIdentity resourceGroup()

Gets the resourceGroup. The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.

Returns:

the resourceGroup

type

public String type()

Gets the type. The crypto-system for this key.

Returns:

the type