/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.geo.model; import java.io.Serializable; public class DescribeKeyResult implements Serializable { /** *
* The timestamp for when the API key resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The optional description for the API key resource. *
*
* Constraints:
* Length: 0 - 1000
*/
private String description;
/**
*
* The timestamp for when the API key resource will expire in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The key value/string of an API key. *
*
* Constraints:
* Length: 0 - 1000
*/
private String key;
/**
*
* 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
*
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-
* 9]+)*)?){2}:([^/].*)?$
*/
private String keyArn;
/**
*
* The name of the API key resource. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*/
private String keyName;
/**
*
* API Restrictions on the allowed actions, resources, and referers for an * API key resource. *
*/ private ApiKeyRestrictions restrictions; /** ** Tags associated with the API key resource. *
*/ private java.util.Map
* The timestamp for when the API key resource was last updated in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource was created in
* ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource was created in
* ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param createTime
* The timestamp for when the API key resource was created in
* ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The optional description for the API key resource. *
*
* Constraints:
* Length: 0 - 1000
*
* @return
* The optional description for the API key resource. *
*/ public String getDescription() { return description; } /** ** The optional description for the API key resource. *
*
* Constraints:
* Length: 0 - 1000
*
* @param description
* The optional description for the API key resource. *
*/ public void setDescription(String description) { this.description = description; } /** ** The optional description for the API key resource. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 1000
*
* @param description
* The optional description for the API key resource. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeKeyResult withDescription(String description) { this.description = description; return this; } /** *
* The timestamp for when the API key resource will expire in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource will expire in
* ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource will expire in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource will expire in
* ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The timestamp for when the API key resource will expire in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param expireTime
* The timestamp for when the API key resource will expire in
* ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
*
* The key value/string of an API key. *
*
* Constraints:
* Length: 0 - 1000
*
* @return
* The key value/string of an API key. *
*/ public String getKey() { return key; } /** ** The key value/string of an API key. *
*
* Constraints:
* Length: 0 - 1000
*
* @param key
* The key value/string of an API key. *
*/ public void setKey(String key) { this.key = key; } /** ** The key value/string of an API key. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 1000
*
* @param key
* The key value/string of an API key. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeKeyResult withKey(String key) { this.key = key; return this; } /** ** 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
*
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-
* 9]+)*)?){2}:([^/].*)?$
*
* @return
* 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
*
* 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
*
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-
* 9]+)*)?){2}:([^/].*)?$
*
* @param 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
*
* 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 1600
* Pattern:
* ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-
* 9]+)*)?){2}:([^/].*)?$
*
* @param 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
*
* The name of the API key resource. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*
* @return
* The name of the API key resource. *
*/ public String getKeyName() { return keyName; } /** ** The name of the API key resource. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*
* @param keyName
* The name of the API key resource. *
*/ public void setKeyName(String keyName) { this.keyName = keyName; } /** ** The name of the API key resource. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*
* @param keyName
* The name of the API key resource. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeKeyResult withKeyName(String keyName) { this.keyName = keyName; return this; } /** ** API Restrictions on the allowed actions, resources, and referers for an * API key resource. *
* * @return* API Restrictions on the allowed actions, resources, and referers * for an API key resource. *
*/ public ApiKeyRestrictions getRestrictions() { return restrictions; } /** ** API Restrictions on the allowed actions, resources, and referers for an * API key resource. *
* * @param restrictions* API Restrictions on the allowed actions, resources, and * referers for an API key resource. *
*/ public void setRestrictions(ApiKeyRestrictions restrictions) { this.restrictions = restrictions; } /** ** API Restrictions on the allowed actions, resources, and referers for an * API key resource. *
** Returns a reference to this object so that method calls can be chained * together. * * @param restrictions
* API Restrictions on the allowed actions, resources, and * referers for an API key resource. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeKeyResult withRestrictions(ApiKeyRestrictions restrictions) { this.restrictions = restrictions; return this; } /** ** Tags associated with the API key resource. *
* * @return* Tags associated with the API key resource. *
*/ public java.util.Map* Tags associated with the API key resource. *
* * @param tags* Tags associated with the API key resource. *
*/ public void setTags(java.util.Map* Tags associated with the API key resource. *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* Tags associated with the API key resource. *
* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeKeyResult withTags(java.util.Map* Tags associated with the API key resource. *
*
* The method adds a new key-value pair into Tags parameter, and returns a
* reference to this object so that method calls can be chained together.
*
* @param key The key of the entry to be added into Tags.
* @param value The corresponding value of the entry to be added into Tags.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public DescribeKeyResult addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public DescribeKeyResult clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* The timestamp for when the API key resource was last updated in ISO
* 8601 format:
* The timestamp for when the API key resource was last updated in
*
* ISO 8601 format:
* The timestamp for when the API key resource was last updated in ISO
* 8601 format:
* The timestamp for when the API key resource was last updated
* in ISO
* 8601 format:
* The timestamp for when the API key resource was last updated in ISO
* 8601 format:
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param updateTime
* The timestamp for when the API key resource was last updated
* in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
* YYYY-MM-DDThh:mm:ss.sssZ
.
*