GetParametersForImportRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kms.model.KmsRequest
    - - software.amazon.awssdk.services.kms.model.GetParametersForImportRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetParametersForImportRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetParametersForImportRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`keyId()` The identifier of the CMK into which you will import key material.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetParametersForImportRequest.Builder>`	`serializableBuilderClass()`
`GetParametersForImportRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`AlgorithmSpec`	`wrappingAlgorithm()` The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
`String`	`wrappingAlgorithmAsString()` The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial.
`WrappingKeySpec`	`wrappingKeySpec()` The type of wrapping key (public key) to return in the response.
`String`	`wrappingKeySpecAsString()` The type of wrapping key (public key) to return in the response.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - keyId
```
public String keyId()
```
    The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    Returns:
    The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
  - wrappingAlgorithm
```
public AlgorithmSpec wrappingAlgorithm()
```
    The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
    
    If the service returns an enum value that is not available in the current SDK version, wrappingAlgorithm will return AlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingAlgorithmAsString().
    
    Returns:
    
    The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AlgorithmSpec
  - wrappingAlgorithmAsString
```
public String wrappingAlgorithmAsString()
```
    The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
    
    If the service returns an enum value that is not available in the current SDK version, wrappingAlgorithm will return AlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingAlgorithmAsString().
    
    Returns:
    
    The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.
    
    See Also:
    
    AlgorithmSpec
  - wrappingKeySpec
```
public WrappingKeySpec wrappingKeySpec()
```
    The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
    
    If the service returns an enum value that is not available in the current SDK version, wrappingKeySpec will return WrappingKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingKeySpecAsString().
    
    Returns:
    
    The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
    
    See Also:
    
    WrappingKeySpec
  - wrappingKeySpecAsString
```
public String wrappingKeySpecAsString()
```
    The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
    
    If the service returns an enum value that is not available in the current SDK version, wrappingKeySpec will return WrappingKeySpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wrappingKeySpecAsString().
    
    Returns:
    
    The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
    
    See Also:
    
    WrappingKeySpec
  - toBuilder
```
public GetParametersForImportRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetParametersForImportRequest.Builder,GetParametersForImportRequest>
    
    Specified by:
    
    toBuilder in class KmsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetParametersForImportRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetParametersForImportRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class GetParametersForImportRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

keyId

wrappingAlgorithm

wrappingAlgorithmAsString

wrappingKeySpec

wrappingKeySpecAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields