Class UpdateServiceTemplateVersionRequest

    • Method Detail

      • 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 this 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 this 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 a service template version to update.

        Returns:
        A description of a service template version to update.
      • majorVersion

        public final String majorVersion()

        To update a major version of a service template, include major Version.

        Returns:
        To update a major version of a service template, include major Version.
      • minorVersion

        public final String minorVersion()

        To update a minor version of a service template, include minorVersion.

        Returns:
        To update a minor version of a service template, include minorVersion.
      • 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.

        A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

        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.

        A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

        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.

        A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

        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.

        A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

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

      • templateName

        public final String templateName()

        The name of the service template.

        Returns:
        The name of the service template.
      • 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