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

Class CreateServiceTemplateVersionRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

      Returns:
      When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

    • hasCompatibleEnvironmentTemplates

      public final boolean hasCompatibleEnvironmentTemplates()
      For responses, this returns true if the service returned a value for the CompatibleEnvironmentTemplates 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.

    • compatibleEnvironmentTemplates

      public final List<CompatibleEnvironmentTemplateInput> compatibleEnvironmentTemplates()

      An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

      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 hasCompatibleEnvironmentTemplates() method.

      Returns:
      An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

    • description

      public final String description()

      A description of the new version of a service template.

      Returns:
      A description of the new version of a service template.

    • majorVersion

      public final String majorVersion()

      To create a new minor version of the service template, include a major Version.

      To create a new major and minor version of the service template, exclude major Version.

      Returns:
      To create a new minor version of the service template, include a major Version.

      To create a new major and minor version of the service template, exclude major Version.

    • source

      public final TemplateVersionSourceInput source()

      An object that includes the template bundle S3 bucket path and name for the new version of a service template.

      Returns:
      An object that includes the template bundle S3 bucket path and name for the new version of a service template.

    • supportedComponentSources

      public final List<ServiceTemplateSupportedComponentSourceType> supportedComponentSources()

      An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

      For more information about components, see Proton components 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 hasSupportedComponentSources() method.

      Returns:
      An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

      For more information about components, see Proton components in the Proton User Guide.

    • hasSupportedComponentSources

      public final boolean hasSupportedComponentSources()
      For responses, this returns true if the service returned a value for the SupportedComponentSources 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.

    • supportedComponentSourcesAsStrings

      public final List<String> supportedComponentSourcesAsStrings()

      An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

      For more information about components, see Proton components 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 hasSupportedComponentSources() method.

      Returns:
      An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

      For more information about components, see Proton components in the Proton User Guide.

    • 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 service template version. 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 service template version. A tag is a key-value pair.

      For more information, see Proton resources and tagging in the Proton User Guide.

    • templateName

      public final String templateName()

      The name of the service template.

      Returns:
      The name of the service template.

    • toBuilder

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

    • builder

      public static CreateServiceTemplateVersionRequest.Builder builder()

    • serializableBuilderClass

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