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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateComponentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateComponentRequest.Builder	builder()
String	clientToken()	The client token for the updated component.
ComponentDeploymentUpdateType	deploymentType()	The deployment type.
String	deploymentTypeAsString()	The deployment type.
String	description()	An optional customer-provided description of the component.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the component to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateComponentRequest.Builder>	serializableBuilderClass()
String	serviceInstanceName()	The name of the service instance that you want to attach this component to.
String	serviceName()	The name of the service that serviceInstanceName is associated with.
String	serviceSpec()	The service spec that you want the component to use to access service inputs.
String	templateFile()	A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
UpdateComponentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

ComponentDeploymentUpdateType

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:

ComponentDeploymentUpdateType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateComponentRequest.Builder,UpdateComponentRequest>

Specified by:

toBuilder in class ProtonRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo