porcelain

Documentation

Index

• Constants
• Variables
• type CustomTLSCertificate
• type Netlify
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Netlify
  • func NewHTTPClient(formats strfmt.Registry) *Netlify
  • func (n *Netlify) ConfigureSiteTLSCertificate(ctx context.Context, siteID string, cert *CustomTLSCertificate) (*models.SniCertificate, error)
  • func (n *Netlify) CreateSite(ctx context.Context, site *models.Site, configureDNS bool) (*models.Site, error)
  • func (n *Netlify) DeploySite(ctx context.Context, siteID, dir string) (*models.Deploy, error)
  • func (n *Netlify) GetSite(ctx context.Context, siteID string) (*models.Site, error)
  • func (n *Netlify) GetSiteTLSCertificate(ctx context.Context, siteID string) (*models.SniCertificate, error)
  • func (n *Netlify) ListSites(ctx context.Context, params *operations.ListSitesParams) ([]*models.Site, error)
  • func (n *Netlify) SetConcurrentUploadLimit(limit int)
  • func (n *Netlify) SetSyncFileLimit(limit int)
  • func (n *Netlify) UpdateSite(ctx context.Context, site *models.Site) error
  • func (n *Netlify) WaitUntilDeployReady(ctx context.Context, d *models.Deploy) (*models.Deploy, error)
  • func (n *Netlify) WaitUntilTLSCertificateReady(ctx context.Context, siteID string, cert *models.SniCertificate) (*models.SniCertificate, error)

Constants

const DefaultConcurrentUploadLimit = 10

const DefaultSyncFileLimit = 7000

Variables

var Default = NewHTTPClient(nil)

Default netlify HTTP client.

Types

type CustomTLSCertificate

type CustomTLSCertificate struct {
	Certificate    string
	Key            string
	CACertificates string
}

CustomTLSCertificate holds information about custom TLS certificates.

type Netlify

type Netlify struct {
	*plumbing.Netlify
	// contains filtered or unexported fields
}

Netlify is a client for netlify

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Netlify

New creates a new netlify client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Netlify

NewHTTPClient creates a new netlify HTTP client.

func (*Netlify) ConfigureSiteTLSCertificate

func (n *Netlify) ConfigureSiteTLSCertificate(ctx context.Context, siteID string, cert *CustomTLSCertificate) (*models.SniCertificate, error)

ConfigureSiteTLS provisions a TLS certificate for a site with a custom domain. It uses Let's Encrypt if the certificate is empty.

func (*Netlify) CreateSite

func (n *Netlify) CreateSite(ctx context.Context, site *models.Site, configureDNS bool) (*models.Site, error)

CreateSite creates a new site.

func (*Netlify) DeploySite

func (n *Netlify) DeploySite(ctx context.Context, siteID, dir string) (*models.Deploy, error)

DeploySite creates a new deploy for a site given a directory in the filesystem. It uploads the necessary files that changed between deploys.

func (*Netlify) GetSite

func (n *Netlify) GetSite(ctx context.Context, siteID string) (*models.Site, error)

GetSite returns a site.

func (*Netlify) GetSiteTLSCertificate

func (n *Netlify) GetSiteTLSCertificate(ctx context.Context, siteID string) (*models.SniCertificate, error)

GetSiteTLSCertificate shows the TLS certificate configured for a site.

func (*Netlify) ListSites

func (n *Netlify) ListSites(ctx context.Context, params *operations.ListSitesParams) ([]*models.Site, error)

ListSites lists the sites a user has access to.

func (*Netlify) SetConcurrentUploadLimit

func (n *Netlify) SetConcurrentUploadLimit(limit int)

func (*Netlify) SetSyncFileLimit

func (n *Netlify) SetSyncFileLimit(limit int)

func (*Netlify) UpdateSite

func (n *Netlify) UpdateSite(ctx context.Context, site *models.Site) error

UpdateSite modifies an existent site.

func (*Netlify) WaitUntilDeployReady

func (n *Netlify) WaitUntilDeployReady(ctx context.Context, d *models.Deploy) (*models.Deploy, error)

func (*Netlify) WaitUntilTLSCertificateReady

func (n *Netlify) WaitUntilTLSCertificateReady(ctx context.Context, siteID string, cert *models.SniCertificate) (*models.SniCertificate, error)

WaitUntilTLSCertificateReady checks the state of a site's certificate. It waits until the state is "issued", for Let's Encrypt certificates or "custom", which means that the certificate was provided by the user.