Class UpdateComponentRequest

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.UpdateComponentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateComponentRequest.Builder,UpdateComponentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateComponentRequest extends ProtonRequest implements ToCopyableBuilder<UpdateComponentRequest.Builder,UpdateComponentRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      The client token for the updated component.

      Returns:
      The client token for the updated component.

    • deploymentType

      public final ComponentDeploymentUpdateType deploymentType()

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

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return ComponentDeploymentUpdateType.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 component, as follows:

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

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

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return ComponentDeploymentUpdateType.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 component, as follows:

      NONE

      In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

      CURRENT_VERSION

      In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

      See Also:

    • description

      public final String description()

      An optional customer-provided description of the component.

      Returns:
      An optional customer-provided description of the component.

    • name

      public final String name()

      The name of the component to update.

      Returns:
      The name of the component to update.

    • serviceInstanceName

      public final String serviceInstanceName()

      The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

      Returns:
      The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

    • serviceName

      public final String serviceName()

      The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

      Returns:
      The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

    • serviceSpec

      public final String serviceSpec()

      The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

      Returns:
      The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

    • templateFile

      public final String templateFile()

      A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

      Components support a single IaC file, even if you use Terraform as your template language.

      Returns:
      A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

      Components support a single IaC file, even if you use Terraform as your template language.

    • toBuilder

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

    • builder

      public static UpdateComponentRequest.Builder builder()

    • serializableBuilderClass

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