Package software.amazon.awssdk.services.apigateway.model

Class CreateApiKeyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.CreateApiKeyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateApiKeyRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

Request to create an ApiKey resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateApiKeyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateApiKeyRequest.Builder	builder()
String	customerId()	An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
String	description()	The description of the ApiKey.
Boolean	enabled()	Specifies whether the ApiKey can be used by callers.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	generateDistinctId()	Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStageKeys()	For responses, this returns true if the service returned a value for the StageKeys property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the ApiKey.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateApiKeyRequest.Builder>	serializableBuilderClass()
List<StageKey>	stageKeys()	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
Map<String,String>	tags()	The key-value map of strings.
CreateApiKeyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	Specifies a value of the API key.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the ApiKey.

Returns:

The name of the ApiKey.

description

public final String description()

The description of the ApiKey.

Returns:

The description of the ApiKey.

enabled

public final Boolean enabled()

Specifies whether the ApiKey can be used by callers.

Returns:

Specifies whether the ApiKey can be used by callers.

generateDistinctId

public final Boolean generateDistinctId()

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

Returns:

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

value

public final String value()

Specifies a value of the API key.

Returns:

Specifies a value of the API key.

hasStageKeys

public final boolean hasStageKeys()

For responses, this returns true if the service returned a value for the StageKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stageKeys

public final List<StageKey> stageKeys()

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStageKeys() method.

Returns:

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

customerId

public final String customerId()

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

Returns:

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

toBuilder

public CreateApiKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static CreateApiKeyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateApiKeyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo