software.amazon.awssdk.services.location.model

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

Modifier and Type	Method and Description
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.
DescribeKeyResponse.Builder	description(String description) The optional description for the API key resource.
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.
DescribeKeyResponse.Builder	key(String key) The key value/string of an API key.
DescribeKeyResponse.Builder	keyArn(String keyArn) The Amazon Resource Name (ARN) for the API key resource.
DescribeKeyResponse.Builder	keyName(String keyName) The name of the API key resource.
DescribeKeyResponse.Builder	restrictions(ApiKeyRestrictions restrictions) Sets the value of the Restrictions property for this object.
default DescribeKeyResponse.Builder	restrictions(Consumer<ApiKeyRestrictions.Builder> restrictions) Sets the value of the Restrictions property for this object.
DescribeKeyResponse.Builder	tags(Map<String,String> tags) Tags associated with the API key resource.
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.

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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.

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.

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.

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 the ApiKeyRestrictions.Builder avoiding the need to create one manually via ApiKeyRestrictions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to restrictions(ApiKeyRestrictions).

Parameters:

restrictions - a consumer that will call methods on ApiKeyRestrictions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

restrictions(ApiKeyRestrictions)

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.

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.