com.amazonaws.services.proton.model

Class UpdateComponentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.proton.model.UpdateComponentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateComponentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateComponentRequest()

Method Summary

Modifier and Type	Method and Description
UpdateComponentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() The client token for the updated component.
String	getDeploymentType() The deployment type.
String	getDescription() An optional customer-provided description of the component.
String	getName() The name of the component to update.
String	getServiceInstanceName() The name of the service instance that you want to attach this component to.
String	getServiceName() The name of the service that serviceInstanceName is associated with.
String	getServiceSpec() The service spec that you want the component to use to access service inputs.
String	getTemplateFile() A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
int	hashCode()
void	setClientToken(String clientToken) The client token for the updated component.
void	setDeploymentType(String deploymentType) The deployment type.
void	setDescription(String description) An optional customer-provided description of the component.
void	setName(String name) The name of the component to update.
void	setServiceInstanceName(String serviceInstanceName) The name of the service instance that you want to attach this component to.
void	setServiceName(String serviceName) The name of the service that serviceInstanceName is associated with.
void	setServiceSpec(String serviceSpec) The service spec that you want the component to use to access service inputs.
void	setTemplateFile(String templateFile) A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
String	toString() Returns a string representation of this object.
UpdateComponentRequest	withClientToken(String clientToken) The client token for the updated component.
UpdateComponentRequest	withDeploymentType(ComponentDeploymentUpdateType deploymentType) The deployment type.
UpdateComponentRequest	withDeploymentType(String deploymentType) The deployment type.
UpdateComponentRequest	withDescription(String description) An optional customer-provided description of the component.
UpdateComponentRequest	withName(String name) The name of the component to update.
UpdateComponentRequest	withServiceInstanceName(String serviceInstanceName) The name of the service instance that you want to attach this component to.
UpdateComponentRequest	withServiceName(String serviceName) The name of the service that serviceInstanceName is associated with.
UpdateComponentRequest	withServiceSpec(String serviceSpec) The service spec that you want the component to use to access service inputs.
UpdateComponentRequest	withTemplateFile(String templateFile) A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateComponentRequest

public UpdateComponentRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

The client token for the updated component.

Parameters:

clientToken - The client token for the updated component.

getClientToken

public String getClientToken()

The client token for the updated component.

Returns:

The client token for the updated component.

withClientToken

public UpdateComponentRequest withClientToken(String clientToken)

The client token for the updated component.

Parameters:

clientToken - The client token for the updated component.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeploymentType

public void setDeploymentType(String 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.

Parameters:

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.

See Also:

ComponentDeploymentUpdateType

getDeploymentType

public String getDeploymentType()

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.

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

withDeploymentType

public UpdateComponentRequest withDeploymentType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComponentDeploymentUpdateType

withDeploymentType

public UpdateComponentRequest withDeploymentType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComponentDeploymentUpdateType

setDescription

public void setDescription(String description)

An optional customer-provided description of the component.

Parameters:

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

getDescription

public String getDescription()

An optional customer-provided description of the component.

Returns:

An optional customer-provided description of the component.

withDescription

public UpdateComponentRequest withDescription(String description)

An optional customer-provided description of the component.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name of the component to update.

Parameters:

name - The name of the component to update.

getName

public String getName()

The name of the component to update.

Returns:

The name of the component to update.

withName

public UpdateComponentRequest withName(String name)

The name of the component to update.

Parameters:

name - The name of the component to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setServiceInstanceName

public void setServiceInstanceName(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.

Parameters:

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.

getServiceInstanceName

public String getServiceInstanceName()

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.

withServiceInstanceName

public UpdateComponentRequest withServiceInstanceName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setServiceName

public void setServiceName(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.

Parameters:

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.

getServiceName

public String getServiceName()

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.

withServiceName

public UpdateComponentRequest withServiceName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setServiceSpec

public void setServiceSpec(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.

Parameters:

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.

getServiceSpec

public String getServiceSpec()

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.

withServiceSpec

public UpdateComponentRequest withServiceSpec(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTemplateFile

public void setTemplateFile(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.

Parameters:

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.

getTemplateFile

public String getTemplateFile()

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.

withTemplateFile

public UpdateComponentRequest withTemplateFile(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateComponentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()