Package software.amazon.awssdk.services.proton.model

Class UpdateServiceInstanceRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      The client token of the service instance to update.

      Returns:
      The client token of the service instance to update.

    • deploymentType

      public final DeploymentUpdateType deploymentType()

      The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

      CURRENT_VERSION

      In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

      MINOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

      MAJOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

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

      Returns:
      The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

      CURRENT_VERSION

      In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

      MINOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

      MAJOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

      CURRENT_VERSION

      In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

      MINOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

      MAJOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

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

      Returns:
      The deployment type. It defines the mode for updating a service instance, as follows:

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

      CURRENT_VERSION

      In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

      MINOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

      MAJOR_VERSION

      In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

      See Also:

    • name

      public final String name()

      The name of the service instance to update.

      Returns:
      The name of the service instance to update.

    • serviceName

      public final String serviceName()

      The name of the service that the service instance belongs to.

      Returns:
      The name of the service that the service instance belongs to.

    • spec

      public final String spec()

      The formatted specification that defines the service instance update.

      Returns:
      The formatted specification that defines the service instance update.

    • templateMajorVersion

      public final String templateMajorVersion()

      The major version of the service template to update.

      Returns:
      The major version of the service template to update.

    • templateMinorVersion

      public final String templateMinorVersion()

      The minor version of the service template to update.

      Returns:
      The minor version of the service template to update.

    • toBuilder

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

    • builder

      public static UpdateServiceInstanceRequest.Builder builder()

    • serializableBuilderClass

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