platform

Documentation

Index

• Variables
• type DeployConfig
• type Deployment
  • func (*Deployment) Descriptor() ([]byte, []int)
  • func (x *Deployment) GetBucket() string
  • func (x *Deployment) GetProject() string
  • func (x *Deployment) GetRegion() string
  • func (*Deployment) ProtoMessage()
  • func (x *Deployment) ProtoReflect() protoreflect.Message
  • func (x *Deployment) Reset()
  • func (x *Deployment) String() string
• type Platform
  • func (p *Platform) Config() (interface{}, error)
  • func (p *Platform) ConfigSet(config interface{}) error
  • func (p *Platform) Deploy(ctx context.Context, ui terminal.UI) (*Deployment, error)
  • func (p *Platform) DeployFunc() interface{}
  • func (p *Platform) Destroy(ctx context.Context, ui terminal.UI) error
  • func (p *Platform) DestroyFunc() interface{}

Variables

var File_platform_output_proto protoreflect.FileDescriptor

Types

type DeployConfig

type DeployConfig struct {
	Bucket       string `hcl:"bucket"`
	Project      string `hcl:"project"`
	Region       string `hcl:"region,optional"`
	Directory    string `hcl:"directory,optional"`
	IndexPage    string `hcl:"index,optional"`
	NotFoundPage string `hcl:"not_found,optional"`
	BaseDir      string `hcl:"base,optional"`
}

type Deployment

type Deployment struct {
	Bucket  string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	Region  string `protobuf:"bytes,2,opt,name=region,proto3" json:"region,omitempty"`
	Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

You can customise this message to change the fields for the output value from your Deployment

func (*Deployment) Descriptor

func (*Deployment) Descriptor() ([]byte, []int)

Deprecated: Use Deployment.ProtoReflect.Descriptor instead.

func (*Deployment) GetBucket

func (x *Deployment) GetBucket() string

func (*Deployment) GetProject

func (x *Deployment) GetProject() string

func (*Deployment) GetRegion

func (x *Deployment) GetRegion() string

func (*Deployment) ProtoMessage

func (*Deployment) ProtoMessage()

func (*Deployment) ProtoReflect

func (x *Deployment) ProtoReflect() protoreflect.Message

func (*Deployment) Reset

func (x *Deployment) Reset()

func (*Deployment) String

func (x *Deployment) String() string

type Platform

type Platform struct {
	// contains filtered or unexported fields
}

func (*Platform) Config

func (p *Platform) Config() (interface{}, error)

Implement Configurable

func (*Platform) ConfigSet

func (p *Platform) ConfigSet(config interface{}) error

Implement ConfigurableNotify

func (*Platform) Deploy

func (p *Platform) Deploy(ctx context.Context, ui terminal.UI) (*Deployment, error)

If an error is returned, Waypoint stops the execution flow and returns an error to the user.

func (*Platform) DeployFunc

func (p *Platform) DeployFunc() interface{}

Implement Builder

func (*Platform) Destroy

func (p *Platform) Destroy(ctx context.Context, ui terminal.UI) error

If an error is returned, Waypoint stops the execution flow and returns an error to the user.

func (*Platform) DestroyFunc

func (p *Platform) DestroyFunc() interface{}

Implement the Destroyer interface