Class UpdateKeyRequest

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

  • Method Details

    • keyName

      public final String keyName()

      The name of the API key resource to update.

      Returns:
      The name of the API key resource to update.

    • description

      public final String description()

      Updates the description for the API key resource.

      Returns:
      Updates the description for the API key resource.

    • expireTime

      public final Instant expireTime()

      Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

      Returns:
      Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    • noExpiry

      public final Boolean noExpiry()

      Whether the API key should expire. Set to true to set the API key to have no expiration time.

      Returns:
      Whether the API key should expire. Set to true to set the API key to have no expiration time.

    • forceUpdate

      public final Boolean forceUpdate()

      The boolean flag to be included for updating ExpireTime or Restrictions details.

      Must be set to true to update an API key resource that has been used in the past 7 days.

      False if force update is not preferred

      Default value: False

      Returns:
      The boolean flag to be included for updating ExpireTime or Restrictions details.

      Must be set to true to update an API key resource that has been used in the past 7 days.

      False if force update is not preferred

      Default value: False

    • restrictions

      public final ApiKeyRestrictions restrictions()

      Updates the API key restrictions for the API key resource.

      Returns:
      Updates the API key restrictions for the API key resource.

    • toBuilder

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

    • builder

      public static UpdateKeyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateKeyRequest.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.