KeyInner Class

public final class KeyInner
extends Resource

The key resource.

Constructor Summary

Constructor Description
KeyInner()

Creates an instance of KeyInner class.

Method Summary

Modifier and Type Method and Description
KeyAttributes attributes()

Get the attributes property: The attributes of the key.

JsonWebKeyCurveName curveName()

Get the curveName property: The elliptic curve name.

static KeyInner fromJson(JsonReader jsonReader)

Reads an instance of KeyInner from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

List<JsonWebKeyOperation> keyOps()

Get the keyOps property: The keyOps property.

Integer keySize()

Get the keySize property: The key size in bits.

String keyUri()

Get the keyUri property: The URI to retrieve the current version of the key.

String keyUriWithVersion()

Get the keyUriWithVersion property: The URI to retrieve the specific version of the key.

JsonWebKeyType kty()

Get the kty property: The type of the key.

String name()

Get the name property: The name of the resource.

KeyReleasePolicy releasePolicy()

Get the releasePolicy property: Key release policy in response.

RotationPolicy rotationPolicy()

Get the rotationPolicy property: Key rotation policy in response.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

KeyInner withAttributes(KeyAttributes attributes)

Set the attributes property: The attributes of the key.

KeyInner withCurveName(JsonWebKeyCurveName curveName)

Set the curveName property: The elliptic curve name.

KeyInner withKeyOps(List<JsonWebKeyOperation> keyOps)

Set the keyOps property: The keyOps property.

KeyInner withKeySize(Integer keySize)

Set the keySize property: The key size in bits.

KeyInner withKty(JsonWebKeyType kty)

Set the kty property: The type of the key.

KeyInner withLocation(String location)
KeyInner withReleasePolicy(KeyReleasePolicy releasePolicy)

Set the releasePolicy property: Key release policy in response.

KeyInner withRotationPolicy(RotationPolicy rotationPolicy)

Set the rotationPolicy property: Key rotation policy in response.

KeyInner withTags(Map<String,String> tags)

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

KeyInner

public KeyInner()

Creates an instance of KeyInner class.

Method Details

attributes

public KeyAttributes attributes()

Get the attributes property: The attributes of the key.

Returns:

the attributes value.

curveName

public JsonWebKeyCurveName curveName()

Get the curveName property: The elliptic curve name. For valid values, see JsonWebKeyCurveName.

Returns:

the curveName value.

fromJson

public static KeyInner fromJson(JsonReader jsonReader)

Reads an instance of KeyInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KeyInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

KeyInner.id()

Returns:

the id value.

keyOps

public List keyOps()

Get the keyOps property: The keyOps property.

Returns:

the keyOps value.

keySize

public Integer keySize()

Get the keySize property: The key size in bits. For example: 2048, 3072, or 4096 for RSA.

Returns:

the keySize value.

keyUri

public String keyUri()

Get the keyUri property: The URI to retrieve the current version of the key.

Returns:

the keyUri value.

keyUriWithVersion

public String keyUriWithVersion()

Get the keyUriWithVersion property: The URI to retrieve the specific version of the key.

Returns:

the keyUriWithVersion value.

kty

public JsonWebKeyType kty()

Get the kty property: The type of the key. For valid values, see JsonWebKeyType.

Returns:

the kty value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

KeyInner.name()

Returns:

the name value.

releasePolicy

public KeyReleasePolicy releasePolicy()

Get the releasePolicy property: Key release policy in response. It will be used for both output and input. Omitted if empty.

Returns:

the releasePolicy value.

rotationPolicy

public RotationPolicy rotationPolicy()

Get the rotationPolicy property: Key rotation policy in response. It will be used for both output and input. Omitted if empty.

Returns:

the rotationPolicy value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KeyInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

KeyInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAttributes

public KeyInner withAttributes(KeyAttributes attributes)

Set the attributes property: The attributes of the key.

Parameters:

attributes - the attributes value to set.

Returns:

the KeyInner object itself.

withCurveName

public KeyInner withCurveName(JsonWebKeyCurveName curveName)

Set the curveName property: The elliptic curve name. For valid values, see JsonWebKeyCurveName.

Parameters:

curveName - the curveName value to set.

Returns:

the KeyInner object itself.

withKeyOps

public KeyInner withKeyOps(List keyOps)

Set the keyOps property: The keyOps property.

Parameters:

keyOps - the keyOps value to set.

Returns:

the KeyInner object itself.

withKeySize

public KeyInner withKeySize(Integer keySize)

Set the keySize property: The key size in bits. For example: 2048, 3072, or 4096 for RSA.

Parameters:

keySize - the keySize value to set.

Returns:

the KeyInner object itself.

withKty

public KeyInner withKty(JsonWebKeyType kty)

Set the kty property: The type of the key. For valid values, see JsonWebKeyType.

Parameters:

kty - the kty value to set.

Returns:

the KeyInner object itself.

withLocation

public KeyInner withLocation(String location)

Overrides:

KeyInner.withLocation(String location)

Parameters:

location

withReleasePolicy

public KeyInner withReleasePolicy(KeyReleasePolicy releasePolicy)

Set the releasePolicy property: Key release policy in response. It will be used for both output and input. Omitted if empty.

Parameters:

releasePolicy - the releasePolicy value to set.

Returns:

the KeyInner object itself.

withRotationPolicy

public KeyInner withRotationPolicy(RotationPolicy rotationPolicy)

Set the rotationPolicy property: Key rotation policy in response. It will be used for both output and input. Omitted if empty.

Parameters:

rotationPolicy - the rotationPolicy value to set.

Returns:

the KeyInner object itself.

withTags

public KeyInner withTags(Map tags)

Overrides:

KeyInner.withTags(Map<String,String> tags)

Parameters:

tags

Applies to