[github/fretlink/terraform-provider-statuscake.git] / vendor / github.com / hashicorp / terraform / terraform / ui_input.go

package terraform

// UIInput is the interface that must be implemented to ask for input
// from this user. This should forward the request to wherever the user
// inputs things to ask for values.
type UIInput interface {
	Input(*InputOpts) (string, error)
}

// InputOpts are options for asking for input.
type InputOpts struct {
	// Id is a unique ID for the question being asked that might be
	// used for logging or to look up a prior answered question.
	Id string

	// Query is a human-friendly question for inputting this value.
	Query string

	// Description is a description about what this option is. Be wary
	// that this will probably be in a terminal so split lines as you see
	// necessary.
	Description string

	// Default will be the value returned if no data is entered.
	Default string
}
Commit	Line	Data
bae9f6d2 JC	1	package terraform
	2
	3	// UIInput is the interface that must be implemented to ask for input
	4	// from this user. This should forward the request to wherever the user
	5	// inputs things to ask for values.
	6	type UIInput interface {
	7	Input(*InputOpts) (string, error)
	8	}
	9
	10	// InputOpts are options for asking for input.
	11	type InputOpts struct {
	12	// Id is a unique ID for the question being asked that might be
	13	// used for logging or to look up a prior answered question.
	14	Id string
	15
	16	// Query is a human-friendly question for inputting this value.
	17	Query string
	18
	19	// Description is a description about what this option is. Be wary
	20	// that this will probably be in a terminal so split lines as you see
	21	// necessary.
	22	Description string
	23
	24	// Default will be the value returned if no data is entered.
	25	Default string
	26	}