deployments

Documentation

Overview

Package deployments contains auto-generated files. DO NOT MODIFY

Package deployments contains auto-generated files. DO NOT MODIFY

Package deployments contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateDeploymentInput) (*CreateDeploymentResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateDeploymentInput) (*CreateDeploymentResponse, error)
  • func (c *Client) NewDeploymentsPaginator() *DeploymentsPaginator
  • func (c *Client) NewDeploymentsPaginatorWithOptions(options *DeploymentsPageOptions) *DeploymentsPaginator
  • func (c Client) Page(options *DeploymentsPageOptions) (*DeploymentsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *DeploymentsPageOptions) (*DeploymentsPageResponse, error)
• type ClientProperties
• type CreateDeploymentInput
• type CreateDeploymentResponse
• type DeploymentsPage
• type DeploymentsPageOptions
• type DeploymentsPageResponse
• type DeploymentsPaginator
  • func (p *DeploymentsPaginator) CurrentPage() *DeploymentsPageResponse
  • func (p *DeploymentsPaginator) Error() error
  • func (p *DeploymentsPaginator) Next() bool
  • func (p *DeploymentsPaginator) NextWithContext(context context.Context) bool
• type PageDeploymentResponse
• type PageMetaResponse

Types

type Client

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

Client for managing deployment resources See https://www.twilio.com/docs/runtime/functions-assets-api/api/deployment for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the deployments client

func (Client) Create

func (c Client) Create(input *CreateDeploymentInput) (*CreateDeploymentResponse, error)

Create creates a new deployment See https://www.twilio.com/docs/runtime/functions-assets-api/api/deployment#create-a-deployment-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateDeploymentInput) (*CreateDeploymentResponse, error)

CreateWithContext creates a new deployment See https://www.twilio.com/docs/runtime/functions-assets-api/api/deployment#create-a-deployment-resource for more details

func (*Client) NewDeploymentsPaginator

func (c *Client) NewDeploymentsPaginator() *DeploymentsPaginator

NewDeploymentsPaginator creates a new instance of the paginator for Page.

func (*Client) NewDeploymentsPaginatorWithOptions

func (c *Client) NewDeploymentsPaginatorWithOptions(options *DeploymentsPageOptions) *DeploymentsPaginator

NewDeploymentsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *DeploymentsPageOptions) (*DeploymentsPageResponse, error)

Page retrieves a page of deployments See https://www.twilio.com/docs/runtime/functions-assets-api/api/deployment#read-multiple-deployment-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *DeploymentsPageOptions) (*DeploymentsPageResponse, error)

PageWithContext retrieves a page of deployments See https://www.twilio.com/docs/runtime/functions-assets-api/api/deployment#read-multiple-deployment-resources for more details

type ClientProperties

type ClientProperties struct {
	EnvironmentSid string
	ServiceSid     string
}

ClientProperties are the properties required to manage the deployments resources

type CreateDeploymentInput

type CreateDeploymentInput struct {
	BuildSid *string `form:"BuildSid,omitempty"`
}

CreateDeploymentInput defines the input fields for creating a new deployment resource

type CreateDeploymentResponse

type CreateDeploymentResponse struct {
	AccountSid     string     `json:"account_sid"`
	BuildSid       string     `json:"build_sid"`
	DateCreated    time.Time  `json:"date_created"`
	DateUpdated    *time.Time `json:"date_updated,omitempty"`
	EnvironmentSid string     `json:"environment_sid"`
	ServiceSid     string     `json:"service_sid"`
	Sid            string     `json:"sid"`
	URL            string     `json:"url"`
}

CreateDeploymentResponse defines the response fields for the created deployment

type DeploymentsPage

type DeploymentsPage struct {
	CurrentPage *DeploymentsPageResponse
	Error       error
	// contains filtered or unexported fields
}

DeploymentsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageDeploymentResponse or error that is returned from the api call(s)

type DeploymentsPageOptions

type DeploymentsPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

DeploymentsPageOptions defines the query options for the api operation

type DeploymentsPageResponse

type DeploymentsPageResponse struct {
	Deployments []PageDeploymentResponse `json:"deployments"`
	Meta        PageMetaResponse         `json:"meta"`
}

DeploymentsPageResponse defines the response fields for the deployments page

type DeploymentsPaginator

type DeploymentsPaginator struct {
	Page        *DeploymentsPage
	Deployments []PageDeploymentResponse
	// contains filtered or unexported fields
}

DeploymentsPaginator defines the fields for makings paginated api calls Deployments is an array of deployments that have been returned from all of the page calls

func (*DeploymentsPaginator) CurrentPage

func (p *DeploymentsPaginator) CurrentPage() *DeploymentsPageResponse

CurrentPage retrieves the results for the current page

func (*DeploymentsPaginator) Error

func (p *DeploymentsPaginator) Error() error

Error retrieves the error returned from the page

func (*DeploymentsPaginator) Next

func (p *DeploymentsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*DeploymentsPaginator) NextWithContext

func (p *DeploymentsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate

type PageDeploymentResponse

type PageDeploymentResponse struct {
	AccountSid     string     `json:"account_sid"`
	BuildSid       string     `json:"build_sid"`
	DateCreated    time.Time  `json:"date_created"`
	DateUpdated    *time.Time `json:"date_updated,omitempty"`
	EnvironmentSid string     `json:"environment_sid"`
	ServiceSid     string     `json:"service_sid"`
	Sid            string     `json:"sid"`
	URL            string     `json:"url"`
}

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}