Documentation
¶
Index ¶
- type ItemJsonOutputRedactedRequestBuilder
- type ItemJsonOutputRequestBuilder
- type ItemJsonSchemaRequestBuilder
- type PlansItemRequestBuilder
- func (m *PlansItemRequestBuilder) Get(ctx context.Context, ...) (...)
- func (m *PlansItemRequestBuilder) JsonOutput() *ItemJsonOutputRequestBuilder
- func (m *PlansItemRequestBuilder) JsonOutputRedacted() *ItemJsonOutputRedactedRequestBuilder
- func (m *PlansItemRequestBuilder) JsonSchema() *ItemJsonSchemaRequestBuilder
- func (m *PlansItemRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *PlansItemRequestBuilder) WithUrl(rawUrl string) *PlansItemRequestBuilder
- type PlansRequestBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ItemJsonOutputRedactedRequestBuilder ¶
type ItemJsonOutputRedactedRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemJsonOutputRedactedRequestBuilder builds and executes requests for operations under \plans\{id}\json-output-redacted
func NewItemJsonOutputRedactedRequestBuilder ¶
func NewItemJsonOutputRedactedRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemJsonOutputRedactedRequestBuilder
NewItemJsonOutputRedactedRequestBuilder instantiates a new ItemJsonOutputRedactedRequestBuilder and sets the default values.
func NewItemJsonOutputRedactedRequestBuilderInternal ¶
func NewItemJsonOutputRedactedRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemJsonOutputRedactedRequestBuilder
NewItemJsonOutputRedactedRequestBuilderInternal instantiates a new ItemJsonOutputRedactedRequestBuilder and sets the default values.
func (*ItemJsonOutputRedactedRequestBuilder) Get ¶
func (m *ItemJsonOutputRedactedRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Get this endpoint generates a temporary authenticated URL to the location of the redacted JSON formatted execution plan, or returns the parsed redacted plan inline when the pre-generated file is not yet available.This endpoint is available for plans using Terraform 0.15.2 and later. The temporary URL has a life of 1 minute and should not be relied upon beyond the initial request. returns a Errors error when the service returns a 404 status code returns a Errors error when the service returns a 422 status code returns a Errors error when the service returns a 4XX or 5XX status code
func (*ItemJsonOutputRedactedRequestBuilder) ToGetRequestInformation ¶
func (m *ItemJsonOutputRedactedRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation this endpoint generates a temporary authenticated URL to the location of the redacted JSON formatted execution plan, or returns the parsed redacted plan inline when the pre-generated file is not yet available.This endpoint is available for plans using Terraform 0.15.2 and later. The temporary URL has a life of 1 minute and should not be relied upon beyond the initial request. returns a *RequestInformation when successful
func (*ItemJsonOutputRedactedRequestBuilder) WithUrl ¶
func (m *ItemJsonOutputRedactedRequestBuilder) WithUrl(rawUrl string) *ItemJsonOutputRedactedRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemJsonOutputRedactedRequestBuilder when successful
type ItemJsonOutputRequestBuilder ¶
type ItemJsonOutputRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemJsonOutputRequestBuilder builds and executes requests for operations under \plans\{id}\json-output
func NewItemJsonOutputRequestBuilder ¶
func NewItemJsonOutputRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemJsonOutputRequestBuilder
NewItemJsonOutputRequestBuilder instantiates a new ItemJsonOutputRequestBuilder and sets the default values.
func NewItemJsonOutputRequestBuilderInternal ¶
func NewItemJsonOutputRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemJsonOutputRequestBuilder
NewItemJsonOutputRequestBuilderInternal instantiates a new ItemJsonOutputRequestBuilder and sets the default values.
func (*ItemJsonOutputRequestBuilder) Get ¶
func (m *ItemJsonOutputRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Get this endpoint generates a temporary authenticated URL to the location of the JSON formatted execution plan.When successful, this endpoint responds with a temporary redirect that should be followed.This endpoint is available for plans using Terraform 0.12 and later.The temporary URL has a life of 1 minute and should not be relied upon beyond the initial request. returns a Errors error when the service returns a 422 status code returns a Errors error when the service returns a 4XX or 5XX status code
func (*ItemJsonOutputRequestBuilder) ToGetRequestInformation ¶
func (m *ItemJsonOutputRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation this endpoint generates a temporary authenticated URL to the location of the JSON formatted execution plan.When successful, this endpoint responds with a temporary redirect that should be followed.This endpoint is available for plans using Terraform 0.12 and later.The temporary URL has a life of 1 minute and should not be relied upon beyond the initial request. returns a *RequestInformation when successful
func (*ItemJsonOutputRequestBuilder) WithUrl ¶
func (m *ItemJsonOutputRequestBuilder) WithUrl(rawUrl string) *ItemJsonOutputRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemJsonOutputRequestBuilder when successful
type ItemJsonSchemaRequestBuilder ¶
type ItemJsonSchemaRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemJsonSchemaRequestBuilder builds and executes requests for operations under \plans\{id}\json-schema
func NewItemJsonSchemaRequestBuilder ¶
func NewItemJsonSchemaRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemJsonSchemaRequestBuilder
NewItemJsonSchemaRequestBuilder instantiates a new ItemJsonSchemaRequestBuilder and sets the default values.
func NewItemJsonSchemaRequestBuilderInternal ¶
func NewItemJsonSchemaRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemJsonSchemaRequestBuilder
NewItemJsonSchemaRequestBuilderInternal instantiates a new ItemJsonSchemaRequestBuilder and sets the default values.
func (*ItemJsonSchemaRequestBuilder) Get ¶
func (m *ItemJsonSchemaRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Get this endpoint generates a temporary authenticated URL to the location of the JSON formatted provider schemas associated with a plan.When successful, this endpoint responds with a temporary redirect that should be followed.This endpoint is available for plans using Terraform 0.12 and later. The temporary URL has a life of 1 minute and should not be relied upon beyond the initial request. returns a Errors error when the service returns a 404 status code returns a Errors error when the service returns a 422 status code returns a Errors error when the service returns a 4XX or 5XX status code
func (*ItemJsonSchemaRequestBuilder) ToGetRequestInformation ¶
func (m *ItemJsonSchemaRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation this endpoint generates a temporary authenticated URL to the location of the JSON formatted provider schemas associated with a plan.When successful, this endpoint responds with a temporary redirect that should be followed.This endpoint is available for plans using Terraform 0.12 and later. The temporary URL has a life of 1 minute and should not be relied upon beyond the initial request. returns a *RequestInformation when successful
func (*ItemJsonSchemaRequestBuilder) WithUrl ¶
func (m *ItemJsonSchemaRequestBuilder) WithUrl(rawUrl string) *ItemJsonSchemaRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemJsonSchemaRequestBuilder when successful
type PlansItemRequestBuilder ¶
type PlansItemRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
PlansItemRequestBuilder builds and executes requests for operations under \plans\{id}
func NewPlansItemRequestBuilder ¶
func NewPlansItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *PlansItemRequestBuilder
NewPlansItemRequestBuilder instantiates a new PlansItemRequestBuilder and sets the default values.
func NewPlansItemRequestBuilderInternal ¶
func NewPlansItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *PlansItemRequestBuilder
NewPlansItemRequestBuilderInternal instantiates a new PlansItemRequestBuilder and sets the default values.
func (*PlansItemRequestBuilder) Get ¶
func (m *PlansItemRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (i05d5aa6b14db285c2e8df48c915f7a7082b77b17cca0def522e18528f80bec16.PlansEnvelopeable, error)
Get this endpoint returns a specific plan by its ID. returns a PlansEnvelopeable when successful returns a Errors error when the service returns a 4XX or 5XX status code
func (*PlansItemRequestBuilder) JsonOutput ¶
func (m *PlansItemRequestBuilder) JsonOutput() *ItemJsonOutputRequestBuilder
JsonOutput the jsonOutput property returns a *ItemJsonOutputRequestBuilder when successful
func (*PlansItemRequestBuilder) JsonOutputRedacted ¶
func (m *PlansItemRequestBuilder) JsonOutputRedacted() *ItemJsonOutputRedactedRequestBuilder
JsonOutputRedacted the jsonOutputRedacted property returns a *ItemJsonOutputRedactedRequestBuilder when successful
func (*PlansItemRequestBuilder) JsonSchema ¶
func (m *PlansItemRequestBuilder) JsonSchema() *ItemJsonSchemaRequestBuilder
JsonSchema the jsonSchema property returns a *ItemJsonSchemaRequestBuilder when successful
func (*PlansItemRequestBuilder) ToGetRequestInformation ¶
func (m *PlansItemRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation this endpoint returns a specific plan by its ID. returns a *RequestInformation when successful
func (*PlansItemRequestBuilder) WithUrl ¶
func (m *PlansItemRequestBuilder) WithUrl(rawUrl string) *PlansItemRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *PlansItemRequestBuilder when successful
type PlansRequestBuilder ¶
type PlansRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
PlansRequestBuilder builds and executes requests for operations under \plans
func NewPlansRequestBuilder ¶
func NewPlansRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *PlansRequestBuilder
NewPlansRequestBuilder instantiates a new PlansRequestBuilder and sets the default values.
func NewPlansRequestBuilderInternal ¶
func NewPlansRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *PlansRequestBuilder
NewPlansRequestBuilderInternal instantiates a new PlansRequestBuilder and sets the default values.
func (*PlansRequestBuilder) ById ¶
func (m *PlansRequestBuilder) ById(id string) *PlansItemRequestBuilder
ById gets an item from the github.com/hashicorp/go-tfe/v2/api.plans.item collection returns a *PlansItemRequestBuilder when successful
Source Files