CreateComponentRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.proton.model.CreateComponentRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateComponentRequest
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

CreateComponentRequest()

Constructors
Constructor and Description
`CreateComponentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateComponentRequest`	`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 created component.
`String`	`getDescription()` An optional customer-provided description of the component.
`String`	`getEnvironmentName()` The name of the Proton environment that you want to associate this component with.
`String`	`getManifest()` A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
`String`	`getName()` The customer-provided name of the component.
`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.
`List<Tag>`	`getTags()` An optional list of metadata items that you can associate with the Proton component.
`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 created component.
`void`	`setDescription(String description)` An optional customer-provided description of the component.
`void`	`setEnvironmentName(String environmentName)` The name of the Proton environment that you want to associate this component with.
`void`	`setManifest(String manifest)` A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
`void`	`setName(String name)` The customer-provided name of the component.
`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`	`setTags(Collection<Tag> tags)` An optional list of metadata items that you can associate with the Proton component.
`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.
`CreateComponentRequest`	`withClientToken(String clientToken)` The client token for the created component.
`CreateComponentRequest`	`withDescription(String description)` An optional customer-provided description of the component.
`CreateComponentRequest`	`withEnvironmentName(String environmentName)` The name of the Proton environment that you want to associate this component with.
`CreateComponentRequest`	`withManifest(String manifest)` A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
`CreateComponentRequest`	`withName(String name)` The customer-provided name of the component.
`CreateComponentRequest`	`withServiceInstanceName(String serviceInstanceName)` The name of the service instance that you want to attach this component to.
`CreateComponentRequest`	`withServiceName(String serviceName)` The name of the service that `serviceInstanceName` is associated with.
`CreateComponentRequest`	`withServiceSpec(String serviceSpec)` The service spec that you want the component to use to access service inputs.
`CreateComponentRequest`	`withTags(Collection<Tag> tags)` An optional list of metadata items that you can associate with the Proton component.
`CreateComponentRequest`	`withTags(Tag... tags)` An optional list of metadata items that you can associate with the Proton component.
`CreateComponentRequest`	`withTemplateFile(String templateFile)` A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateComponentRequest
```
public CreateComponentRequest()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String clientToken)
```
    The client token for the created component.
    
    Parameters:
    
    clientToken - The client token for the created component.
  - getClientToken
```
public String getClientToken()
```
    The client token for the created component.
    
    Returns:
    
    The client token for the created component.
  - withClientToken
```
public CreateComponentRequest withClientToken(String clientToken)
```
    The client token for the created component.
    
    Parameters:
    
    clientToken - The client token for the created component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CreateComponentRequest 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.
  - setEnvironmentName
```
public void setEnvironmentName(String environmentName)
```
    The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
    
    Parameters:
    
    environmentName - The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
    
    Returns:
    
    The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
  - withEnvironmentName
```
public CreateComponentRequest withEnvironmentName(String environmentName)
```
    The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
    
    Parameters:
    
    environmentName - The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setManifest
```
public void setManifest(String manifest)
```
    A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
    
    Parameters:
    
    manifest - A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
  - getManifest
```
public String getManifest()
```
    A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
    
    Returns:
    
    A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
  - withManifest
```
public CreateComponentRequest withManifest(String manifest)
```
    A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
    
    Parameters:
    
    manifest - A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The customer-provided name of the component.
    
    Parameters:
    
    name - The customer-provided name of the component.
  - getName
```
public String getName()
```
    The customer-provided name of the component.
    
    Returns:
    
    The customer-provided name of the component.
  - withName
```
public CreateComponentRequest withName(String name)
```
    The customer-provided name of the component.
    
    Parameters:
    
    name - The customer-provided name of the component.
    
    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. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
    
    Parameters:
    
    serviceInstanceName - The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
  - getServiceInstanceName
```
public String getServiceInstanceName()
```
    The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
    
    Returns:
    
    The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
  - withServiceInstanceName
```
public CreateComponentRequest withServiceInstanceName(String serviceInstanceName)
```
    The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
    
    Parameters:
    
    serviceInstanceName - The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or 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. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
    
    Parameters:
    
    serviceName - The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
  - getServiceName
```
public String getServiceName()
```
    The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
    
    Returns:
    
    The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
  - withServiceName
```
public CreateComponentRequest withServiceName(String serviceName)
```
    The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
    
    Parameters:
    
    serviceName - The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or 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 you attach the component to a service instance.
    
    Parameters:
    
    serviceSpec - The service spec that you want the component to use to access service inputs. Set this only when you attach the component 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 you attach the component to a service instance.
    
    Returns:
    
    The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
  - withServiceSpec
```
public CreateComponentRequest withServiceSpec(String serviceSpec)
```
    The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
    
    Parameters:
    
    serviceSpec - The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
    
    Returns:
    
    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
    
    Parameters:
    
    tags - An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
  - withTags
```
public CreateComponentRequest withTags(Tag... tags)
```
    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateComponentRequest withTags(Collection<Tag> tags)
```
    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
    
    Parameters:
    
    tags - An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
    
    For more information, see Proton resources and tagging in the Proton User Guide.
    
    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 CreateComponentRequest 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 CreateComponentRequest 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()

AWS SDK for Java 1.x API Reference - 1.12.773

Class CreateComponentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateComponentRequest

Method Detail

setClientToken

getClientToken

withClientToken

setDescription

getDescription

withDescription

setEnvironmentName

getEnvironmentName

withEnvironmentName

setManifest

getManifest

withManifest

setName

getName

withName

setServiceInstanceName

getServiceInstanceName

withServiceInstanceName

setServiceName

getServiceName

withServiceName

setServiceSpec

getServiceSpec

withServiceSpec

getTags

setTags

withTags

withTags

setTemplateFile

getTemplateFile

withTemplateFile

toString

equals

hashCode

clone