Class CreateApiKeyRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateApiKeyRequest.Builder,
CreateApiKeyRequest>
Request to create an ApiKey resource.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateApiKeyRequest.Builder
builder()
final String
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.final String
The description of the ApiKey.final Boolean
enabled()
Specifies whether the ApiKey can be used by callers.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Specifies whether (true
) or not (false
) the key identifier is distinct from the created API key value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StageKeys property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The name of the ApiKey.static Class
<? extends CreateApiKeyRequest.Builder> DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.tags()
The key-value map of strings.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
Specifies a value of the API key.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the ApiKey.
- Returns:
- The name of the ApiKey.
-
description
The description of the ApiKey.
- Returns:
- The description of the ApiKey.
-
enabled
Specifies whether the ApiKey can be used by callers.
- Returns:
- Specifies whether the ApiKey can be used by callers.
-
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateApiKeyRequest.Builder,
CreateApiKeyRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-