Class GetInstanceTpmEkPubRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.GetInstanceTpmEkPubRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetInstanceTpmEkPubRequest.Builder,GetInstanceTpmEkPubRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetInstanceTpmEkPubRequest extends Ec2Request implements ToCopyableBuilder<GetInstanceTpmEkPubRequest.Builder,GetInstanceTpmEkPubRequest>

  • Method Details

    • instanceId

      public final String instanceId()

      The ID of the instance for which to get the public endorsement key.

      Returns:
      The ID of the instance for which to get the public endorsement key.

    • keyType

      public final EkPubKeyType keyType()

      The required public endorsement key type.

      If the service returns an enum value that is not available in the current SDK version, keyType will return EkPubKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

      Returns:
      The required public endorsement key type.
      See Also:

    • keyTypeAsString

      public final String keyTypeAsString()

      The required public endorsement key type.

      If the service returns an enum value that is not available in the current SDK version, keyType will return EkPubKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

      Returns:
      The required public endorsement key type.
      See Also:

    • keyFormat

      public final EkPubKeyFormat keyFormat()

      The required public endorsement key format. Specify der for a DER-encoded public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.

      If the service returns an enum value that is not available in the current SDK version, keyFormat will return EkPubKeyFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyFormatAsString().

      Returns:
      The required public endorsement key format. Specify der for a DER-encoded public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.
      See Also:

    • keyFormatAsString

      public final String keyFormatAsString()

      The required public endorsement key format. Specify der for a DER-encoded public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.

      If the service returns an enum value that is not available in the current SDK version, keyFormat will return EkPubKeyFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyFormatAsString().

      Returns:
      The required public endorsement key format. Specify der for a DER-encoded public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded.
      See Also:

    • dryRun

      public final Boolean dryRun()

      Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is DryRunOperation. Otherwise, the response is UnauthorizedOperation.

      Returns:
      Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is DryRunOperation. Otherwise, the response is UnauthorizedOperation.

    • toBuilder

      public GetInstanceTpmEkPubRequest.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<GetInstanceTpmEkPubRequest.Builder,GetInstanceTpmEkPubRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static GetInstanceTpmEkPubRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetInstanceTpmEkPubRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final 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 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.