DescribeKeyResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.location.model.LocationResponse
    - - software.amazon.awssdk.services.location.model.DescribeKeyResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeKeyResponse.Builder,DescribeKeyResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeKeyResponse
extends LocationResponse
implements ToCopyableBuilder<DescribeKeyResponse.Builder,DescribeKeyResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeKeyResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeKeyResponse.Builder`	`builder()`
`Instant`	`createTime()` The timestamp for when the API key resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`String`	`description()` The optional description for the API key resource.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`expireTime()` The timestamp for when the API key resource will expire in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`key()` The key value/string of an API key.
`String`	`keyArn()` The Amazon Resource Name (ARN) for the API key resource.
`String`	`keyName()` The name of the API key resource.
`ApiKeyRestrictions`	`restrictions()` Returns the value of the Restrictions property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeKeyResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` Tags associated with the API key resource.
`DescribeKeyResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updateTime()` The timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse
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
  - createTime
```
public final Instant createTime()
```
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - description
```
public final String description()
```
    The optional description for the API key resource.
    
    Returns:
    
    The optional description for the API key resource.
  - expireTime
```
public final Instant expireTime()
```
    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - key
```
public final String key()
```
    The key value/string of an API key.
    
    Returns:
    
    The key value/string of an API key.
  - keyArn
```
public final String keyArn()
```
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    - Format example: arn:aws:geo:region:account-id:key/ExampleKey
    Returns:
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    
    Format example: arn:aws:geo:region:account-id:key/ExampleKey
  - keyName
```
public final String keyName()
```
    The name of the API key resource.
    
    Returns:
    
    The name of the API key resource.
  - restrictions
```
public final ApiKeyRestrictions restrictions()
```
    Returns the value of the Restrictions property for this object.
    
    Returns:
    
    The value of the Restrictions property for this object.
  - 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()
```
    Tags associated with the API key resource.
    
    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:
    
    Tags associated with the API key resource.
  - updateTime
```
public final Instant updateTime()
```
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - toBuilder
```
public DescribeKeyResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeKeyResponse.Builder,DescribeKeyResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeKeyResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeKeyResponse.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 DescribeKeyResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

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

createTime

description

expireTime

key

keyArn

keyName

restrictions

hasTags

tags

updateTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields