Class CreateComponentRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      The client token for the created component.

      Returns:
      The client token for the created component.

    • description

      public final String description()

      An optional customer-provided description of the component.

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

    • environmentName

      public final 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.

      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.

    • manifest

      public final 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.

      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.

    • name

      public final String name()

      The customer-provided name of the component.

      Returns:
      The customer-provided name of the component.

    • serviceInstanceName

      public final 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.

      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.

    • serviceName

      public final 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.

      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.

    • serviceSpec

      public final 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.

      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      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.

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

    • builder

      public static CreateComponentRequest.Builder builder()

    • serializableBuilderClass

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