Class TemplateLink


  • public final class TemplateLink
    extends Object
    Entity representing the reference to the template.
    • Constructor Detail

      • TemplateLink

        public TemplateLink()
    • Method Detail

      • uri

        public String uri()
        Get the uri property: The URI of the template to deploy. Use either the uri or id property, but not both.
        Returns:
        the uri value.
      • withUri

        public TemplateLink withUri​(String uri)
        Set the uri property: The URI of the template to deploy. Use either the uri or id property, but not both.
        Parameters:
        uri - the uri value to set.
        Returns:
        the TemplateLink object itself.
      • id

        public String id()
        Get the id property: The resource id of a Template Spec. Use either the id or uri property, but not both.
        Returns:
        the id value.
      • withId

        public TemplateLink withId​(String id)
        Set the id property: The resource id of a Template Spec. Use either the id or uri property, but not both.
        Parameters:
        id - the id value to set.
        Returns:
        the TemplateLink object itself.
      • relativePath

        public String relativePath()
        Get the relativePath property: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs.
        Returns:
        the relativePath value.
      • withRelativePath

        public TemplateLink withRelativePath​(String relativePath)
        Set the relativePath property: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs.
        Parameters:
        relativePath - the relativePath value to set.
        Returns:
        the TemplateLink object itself.
      • contentVersion

        public String contentVersion()
        Get the contentVersion property: If included, must match the ContentVersion in the template.
        Returns:
        the contentVersion value.
      • withContentVersion

        public TemplateLink withContentVersion​(String contentVersion)
        Set the contentVersion property: If included, must match the ContentVersion in the template.
        Parameters:
        contentVersion - the contentVersion value to set.
        Returns:
        the TemplateLink object itself.
      • queryString

        public String queryString()
        Get the queryString property: The query string (for example, a SAS token) to be used with the templateLink URI.
        Returns:
        the queryString value.
      • withQueryString

        public TemplateLink withQueryString​(String queryString)
        Set the queryString property: The query string (for example, a SAS token) to be used with the templateLink URI.
        Parameters:
        queryString - the queryString value to set.
        Returns:
        the TemplateLink object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.