Class StaticSite


  • public final class StaticSite
    extends Object
    A static site.
    • Constructor Detail

      • StaticSite

        public StaticSite()
    • Method Detail

      • defaultHostname

        public String defaultHostname()
        Get the defaultHostname property: The default autogenerated hostname for the static site.
        Returns:
        the defaultHostname value.
      • repositoryUrl

        public String repositoryUrl()
        Get the repositoryUrl property: URL for the repository of the static site.
        Returns:
        the repositoryUrl value.
      • withRepositoryUrl

        public StaticSite withRepositoryUrl​(String repositoryUrl)
        Set the repositoryUrl property: URL for the repository of the static site.
        Parameters:
        repositoryUrl - the repositoryUrl value to set.
        Returns:
        the StaticSite object itself.
      • branch

        public String branch()
        Get the branch property: The target branch in the repository.
        Returns:
        the branch value.
      • withBranch

        public StaticSite withBranch​(String branch)
        Set the branch property: The target branch in the repository.
        Parameters:
        branch - the branch value to set.
        Returns:
        the StaticSite object itself.
      • customDomains

        public List<String> customDomains()
        Get the customDomains property: The custom domains associated with this static site.
        Returns:
        the customDomains value.
      • repositoryToken

        public String repositoryToken()
        Get the repositoryToken property: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
        Returns:
        the repositoryToken value.
      • withRepositoryToken

        public StaticSite withRepositoryToken​(String repositoryToken)
        Set the repositoryToken property: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
        Parameters:
        repositoryToken - the repositoryToken value to set.
        Returns:
        the StaticSite object itself.
      • buildProperties

        public StaticSiteBuildProperties buildProperties()
        Get the buildProperties property: Build properties to configure on the repository.
        Returns:
        the buildProperties value.
      • withBuildProperties

        public StaticSite withBuildProperties​(StaticSiteBuildProperties buildProperties)
        Set the buildProperties property: Build properties to configure on the repository.
        Parameters:
        buildProperties - the buildProperties value to set.
        Returns:
        the StaticSite object itself.
      • stagingEnvironmentPolicy

        public StagingEnvironmentPolicy stagingEnvironmentPolicy()
        Get the stagingEnvironmentPolicy property: State indicating whether staging environments are allowed or not allowed for a static web app.
        Returns:
        the stagingEnvironmentPolicy value.
      • withStagingEnvironmentPolicy

        public StaticSite withStagingEnvironmentPolicy​(StagingEnvironmentPolicy stagingEnvironmentPolicy)
        Set the stagingEnvironmentPolicy property: State indicating whether staging environments are allowed or not allowed for a static web app.
        Parameters:
        stagingEnvironmentPolicy - the stagingEnvironmentPolicy value to set.
        Returns:
        the StaticSite object itself.
      • allowConfigFileUpdates

        public Boolean allowConfigFileUpdates()
        Get the allowConfigFileUpdates property: <code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>.
        Returns:
        the allowConfigFileUpdates value.
      • withAllowConfigFileUpdates

        public StaticSite withAllowConfigFileUpdates​(Boolean allowConfigFileUpdates)
        Set the allowConfigFileUpdates property: <code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>.
        Parameters:
        allowConfigFileUpdates - the allowConfigFileUpdates value to set.
        Returns:
        the StaticSite object itself.
      • templateProperties

        public StaticSiteTemplateOptions templateProperties()
        Get the templateProperties property: Template options for generating a new repository.
        Returns:
        the templateProperties value.
      • withTemplateProperties

        public StaticSite withTemplateProperties​(StaticSiteTemplateOptions templateProperties)
        Set the templateProperties property: Template options for generating a new repository.
        Parameters:
        templateProperties - the templateProperties value to set.
        Returns:
        the StaticSite object itself.
      • contentDistributionEndpoint

        public String contentDistributionEndpoint()
        Get the contentDistributionEndpoint property: The content distribution endpoint for the static site.
        Returns:
        the contentDistributionEndpoint value.
      • keyVaultReferenceIdentity

        public String keyVaultReferenceIdentity()
        Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.
        Returns:
        the keyVaultReferenceIdentity value.
      • userProvidedFunctionApps

        public List<StaticSiteUserProvidedFunctionApp> userProvidedFunctionApps()
        Get the userProvidedFunctionApps property: User provided function apps registered with the static site.
        Returns:
        the userProvidedFunctionApps value.
      • provider

        public String provider()
        Get the provider property: The provider that submitted the last deployment to the primary environment of the static site.
        Returns:
        the provider value.
      • withProvider

        public StaticSite withProvider​(String provider)
        Set the provider property: The provider that submitted the last deployment to the primary environment of the static site.
        Parameters:
        provider - the provider value to set.
        Returns:
        the StaticSite object itself.
      • enterpriseGradeCdnStatus

        public EnterpriseGradeCdnStatus enterpriseGradeCdnStatus()
        Get the enterpriseGradeCdnStatus property: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
        Returns:
        the enterpriseGradeCdnStatus value.
      • withEnterpriseGradeCdnStatus

        public StaticSite withEnterpriseGradeCdnStatus​(EnterpriseGradeCdnStatus enterpriseGradeCdnStatus)
        Set the enterpriseGradeCdnStatus property: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
        Parameters:
        enterpriseGradeCdnStatus - the enterpriseGradeCdnStatus value to set.
        Returns:
        the StaticSite object itself.
      • validate

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