Package com.ibm.cloud.platform_services.iam_identity.v1.model

Class ApiKeyInsideCreateServiceIdRequest

java.lang.Object

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

com.ibm.cloud.platform_services.iam_identity.v1.model.ApiKeyInsideCreateServiceIdRequest

All Implemented Interfaces:

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

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

Parameters for the API key in the Create service Id V1 REST request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApiKeyInsideCreateServiceIdRequest.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
java.lang.String	apikey()	Gets the apikey.
java.lang.String	description()	Gets the description.
java.lang.String	name()	Gets the name.
ApiKeyInsideCreateServiceIdRequest.Builder	newBuilder()	New builder.
java.lang.Boolean	storeValue()	Gets the storeValue.

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 Detail

newBuilder

public ApiKeyInsideCreateServiceIdRequest.Builder newBuilder()

New builder.

Returns:

a ApiKeyInsideCreateServiceIdRequest builder

name

public java.lang.String name()

Gets the name. Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.

Returns:

the name

description

public java.lang.String description()

Gets the description. The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.

Returns:

the description

apikey

public java.lang.String apikey()

Gets the apikey. You can optionally passthrough the API key value for this API key. If passed, a minimum length validation of 32 characters for that apiKey value is done, i.e. the value can contain any characters and can even be non-URL safe, but the minimum length requirement must be met. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.

Returns:

the apikey

storeValue

public java.lang.Boolean storeValue()

Gets the storeValue. Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users.

Returns:

the storeValue