UpdateApiKeyResponse (AWS Java SDK :: Services :: Amazon API Gateway 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.UpdateApiKeyResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateApiKeyResponse.Builder,UpdateApiKeyResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateApiKeyResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<UpdateApiKeyResponse.Builder,UpdateApiKeyResponse>
```
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateApiKeyResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateApiKeyResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateApiKeyResponse.Builder`	`builder()`
`Instant`	`createdDate()` The timestamp when the API Key was created.
`String`	`customerId()` An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
`String`	`description()` The description of the API Key.
`Boolean`	`enabled()` Specifies whether the API Key can be used by callers.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasStageKeys()` Returns true if the StageKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`id()` The identifier of the API Key.
`Instant`	`lastUpdatedDate()` The timestamp when the API Key was last updated.
`String`	`name()` The name of the API Key.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateApiKeyResponse.Builder>`	`serializableBuilderClass()`
`List<String>`	`stageKeys()` A list of Stage resources that are associated with the ApiKey resource.
`Map<String,String>`	`tags()` The collection of tags.
`UpdateApiKeyResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`value()` The value of the API Key.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - id
```
public final String id()
```
    The identifier of the API Key.
    
    Returns:
    
    The identifier of the API Key.
  - value
```
public final String value()
```
    The value of the API Key.
    
    Returns:
    
    The value of the API Key.
  - name
```
public final String name()
```
    The name of the API Key.
    
    Returns:
    
    The name of the API Key.
  - customerId
```
public final String customerId()
```
    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    
    Returns:
    
    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
  - description
```
public final String description()
```
    The description of the API Key.
    
    Returns:
    
    The description of the API Key.
  - enabled
```
public final Boolean enabled()
```
    Specifies whether the API Key can be used by callers.
    
    Returns:
    
    Specifies whether the API Key can be used by callers.
  - createdDate
```
public final Instant createdDate()
```
    The timestamp when the API Key was created.
    
    Returns:
    
    The timestamp when the API Key was created.
  - lastUpdatedDate
```
public final Instant lastUpdatedDate()
```
    The timestamp when the API Key was last updated.
    
    Returns:
    
    The timestamp when the API Key was last updated.
  - hasStageKeys
```
public final boolean hasStageKeys()
```
    Returns true if the StageKeys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - stageKeys
```
public final List<String> stageKeys()
```
    A list of Stage resources that are associated with the ApiKey resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasStageKeys() to see if a value was sent in this field.
    
    Returns:
    
    A list of Stage resources that are associated with the ApiKey resource.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - toBuilder
```
public UpdateApiKeyResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateApiKeyResponse.Builder,UpdateApiKeyResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static UpdateApiKeyResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateApiKeyResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateApiKeyResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

id

value

name

customerId

description

enabled

createdDate

lastUpdatedDate

hasStageKeys

stageKeys

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields