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

Class ServiceTemplateVersion

java.lang.Object
software.amazon.awssdk.services.proton.model.ServiceTemplateVersion
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServiceTemplateVersion.Builder,ServiceTemplateVersion>
@Generated("software.amazon.awssdk:codegen") public final class ServiceTemplateVersion extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceTemplateVersion.Builder,ServiceTemplateVersion>

Detailed data of an Proton service template version resource.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the version of a service template.

      Returns:
      The Amazon Resource Name (ARN) of the version of a service template.

    • 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<CompatibleEnvironmentTemplate> compatibleEnvironmentTemplates()

      An array of compatible environment template names for the major version of a service template.

      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 compatible environment template names for the major version of a service template.

    • createdAt

      public final Instant createdAt()

      The time when the version of a service template was created.

      Returns:
      The time when the version of a service template was created.

    • description

      public final String description()

      A description of the version of a service template.

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

    • lastModifiedAt

      public final Instant lastModifiedAt()

      The time when the version of a service template was last modified.

      Returns:
      The time when the version of a service template was last modified.

    • majorVersion

      public final String majorVersion()

      The latest major version that's associated with the version of a service template.

      Returns:
      The latest major version that's associated with the version of a service template.

    • minorVersion

      public final String minorVersion()

      The minor version of a service template.

      Returns:
      The minor version of a service template.

    • recommendedMinorVersion

      public final String recommendedMinorVersion()

      The recommended minor version of the service template.

      Returns:
      The recommended minor version of the service template.

    • schema

      public final String schema()

      The schema of the version of a service template.

      Returns:
      The schema of the version of a service template.

    • status

      public final TemplateVersionStatus status()

      The service template version status.

      If the service returns an enum value that is not available in the current SDK version, status will return TemplateVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The service template version status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The service template version status.

      If the service returns an enum value that is not available in the current SDK version, status will return TemplateVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The service template version status.
      See Also:

    • statusMessage

      public final String statusMessage()

      A service template version status message.

      Returns:
      A service template version status message.

    • 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.

    • templateName

      public final String templateName()

      The name of the version of a service template.

      Returns:
      The name of the version of a service template.

    • toBuilder

      public ServiceTemplateVersion.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<ServiceTemplateVersion.Builder,ServiceTemplateVersion>
      Returns:
      a builder for type T

    • builder

      public static ServiceTemplateVersion.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServiceTemplateVersion.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

    • 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.