Interface DescribeKeyResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeKeyResponse.Builder,DescribeKeyResponse>,LocationResponse.Builder,SdkBuilder<DescribeKeyResponse.Builder,DescribeKeyResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeKeyResponse
public static interface DescribeKeyResponse.Builder extends LocationResponse.Builder, SdkPojo, CopyableBuilder<DescribeKeyResponse.Builder,DescribeKeyResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeKeyResponse.BuildercreateTime(Instant createTime)The timestamp for when the API key resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ.DescribeKeyResponse.Builderdescription(String description)The optional description for the API key resource.DescribeKeyResponse.BuilderexpireTime(Instant expireTime)The timestamp for when the API key resource will expire in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ.DescribeKeyResponse.Builderkey(String key)The key value/string of an API key.DescribeKeyResponse.BuilderkeyArn(String keyArn)The Amazon Resource Name (ARN) for the API key resource.DescribeKeyResponse.BuilderkeyName(String keyName)The name of the API key resource.default DescribeKeyResponse.Builderrestrictions(Consumer<ApiKeyRestrictions.Builder> restrictions)Sets the value of the Restrictions property for this object.DescribeKeyResponse.Builderrestrictions(ApiKeyRestrictions restrictions)Sets the value of the Restrictions property for this object.DescribeKeyResponse.Buildertags(Map<String,String> tags)Tags associated with the API key resource.DescribeKeyResponse.BuilderupdateTime(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 interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.location.model.LocationResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
key
DescribeKeyResponse.Builder key(String key)
The key value/string of an API key.
- Parameters:
key- The key value/string of an API key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyArn
DescribeKeyResponse.Builder keyArn(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
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
keyName
DescribeKeyResponse.Builder keyName(String keyName)
The name of the API key resource.
- Parameters:
keyName- The name of the API key resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restrictions
DescribeKeyResponse.Builder restrictions(ApiKeyRestrictions restrictions)
Sets the value of the Restrictions property for this object.- Parameters:
restrictions- The new value for the Restrictions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restrictions
default DescribeKeyResponse.Builder restrictions(Consumer<ApiKeyRestrictions.Builder> restrictions)
Sets the value of the Restrictions property for this object. This is a convenience method that creates an instance of theApiKeyRestrictions.Builderavoiding the need to create one manually viaApiKeyRestrictions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torestrictions(ApiKeyRestrictions).- Parameters:
restrictions- a consumer that will call methods onApiKeyRestrictions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
restrictions(ApiKeyRestrictions)
-
createTime
DescribeKeyResponse.Builder createTime(Instant createTime)
The timestamp for when the API key resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.- Parameters:
createTime- The timestamp for when the API key resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expireTime
DescribeKeyResponse.Builder expireTime(Instant expireTime)
The timestamp for when the API key resource will expire in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.- Parameters:
expireTime- The timestamp for when the API key resource will expire in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updateTime
DescribeKeyResponse.Builder updateTime(Instant updateTime)
The timestamp for when the API key resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.- Parameters:
updateTime- The timestamp for when the API key resource was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
DescribeKeyResponse.Builder description(String description)
The optional description for the API key resource.
- Parameters:
description- The optional description for the API key resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
DescribeKeyResponse.Builder tags(Map<String,String> tags)
Tags associated with the API key resource.
- Parameters:
tags- Tags associated with the API key resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-