box_service

package
v0.96.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client for box service API

func (*Client) CreateBox

func (a *Client) CreateBox(params *CreateBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateBoxOK, error)

CreateBox creates box creates a new vagrant box

func (*Client) DeleteBox

func (a *Client) DeleteBox(params *DeleteBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteBoxOK, error)
DeleteBox deletes box deletes a vagrant box

Deleting a Box removes all its Versions and Providers as

well. This operation cannot be undone.

func (*Client) ListBoxes

func (a *Client) ListBoxes(params *ListBoxesParams, opts ...ClientOption) (*ListBoxesOK, error)

ListBoxes lists boxes lists all of the boxes within a particular registry

func (*Client) ReadBox

func (a *Client) ReadBox(params *ReadBoxParams, opts ...ClientOption) (*ReadBoxOK, error)

ReadBox reads box reads a vagrant box

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) UpdateBox

func (a *Client) UpdateBox(params *UpdateBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateBoxOK, error)
UpdateBox updates box updates the details of a vagrant box

Note that this only updates details about the Box itself. To

work with a Box's Versions or Providers, use those respective services.

type ClientOption added in v0.23.0

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	CreateBox(params *CreateBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateBoxOK, error)

	DeleteBox(params *DeleteBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteBoxOK, error)

	ListBoxes(params *ListBoxesParams, opts ...ClientOption) (*ListBoxesOK, error)

	ReadBox(params *ReadBoxParams, opts ...ClientOption) (*ReadBoxOK, error)

	UpdateBox(params *UpdateBoxParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateBoxOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

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

New creates a new box service API client.

type CreateBoxBody added in v0.95.0

type CreateBoxBody struct {

	// Details of the Box to create. Note that some fields are ignored
	// on input and should not be set.
	Data *models.HashicorpCloudVagrant20220930Box `json:"data,omitempty"`
}

CreateBoxBody create box body swagger:model CreateBoxBody

func (*CreateBoxBody) ContextValidate added in v0.95.0

func (o *CreateBoxBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create box body based on the context it is used

func (*CreateBoxBody) MarshalBinary added in v0.95.0

func (o *CreateBoxBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateBoxBody) UnmarshalBinary added in v0.95.0

func (o *CreateBoxBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateBoxBody) Validate added in v0.95.0

func (o *CreateBoxBody) Validate(formats strfmt.Registry) error

Validate validates this create box body

type CreateBoxDefault added in v0.95.0

type CreateBoxDefault struct {
	Payload *cloud.GoogleRPCStatus
	// contains filtered or unexported fields
}

CreateBoxDefault describes a response with status code -1, with default header values.

An unexpected error response.

func NewCreateBoxDefault added in v0.95.0

func NewCreateBoxDefault(code int) *CreateBoxDefault

NewCreateBoxDefault creates a CreateBoxDefault with default headers values

func (*CreateBoxDefault) Code added in v0.95.0

func (o *CreateBoxDefault) Code() int

Code gets the status code for the create box default response

func (*CreateBoxDefault) Error added in v0.95.0

func (o *CreateBoxDefault) Error() string

func (*CreateBoxDefault) GetPayload added in v0.95.0

func (o *CreateBoxDefault) GetPayload() *cloud.GoogleRPCStatus

func (*CreateBoxDefault) IsClientError added in v0.95.0

func (o *CreateBoxDefault) IsClientError() bool

IsClientError returns true when this create box default response has a 4xx status code

func (*CreateBoxDefault) IsCode added in v0.95.0

func (o *CreateBoxDefault) IsCode(code int) bool

IsCode returns true when this create box default response a status code equal to that given

func (*CreateBoxDefault) IsRedirect added in v0.95.0

func (o *CreateBoxDefault) IsRedirect() bool

IsRedirect returns true when this create box default response has a 3xx status code

func (*CreateBoxDefault) IsServerError added in v0.95.0

func (o *CreateBoxDefault) IsServerError() bool

IsServerError returns true when this create box default response has a 5xx status code

func (*CreateBoxDefault) IsSuccess added in v0.95.0

func (o *CreateBoxDefault) IsSuccess() bool

IsSuccess returns true when this create box default response has a 2xx status code

func (*CreateBoxDefault) String added in v0.95.0

func (o *CreateBoxDefault) String() string

type CreateBoxOK

type CreateBoxOK struct {
	Payload *models.HashicorpCloudVagrant20220930CreateBoxResponse
}

CreateBoxOK describes a response with status code 200, with default header values.

A successful response.

func NewCreateBoxOK

func NewCreateBoxOK() *CreateBoxOK

NewCreateBoxOK creates a CreateBoxOK with default headers values

func (*CreateBoxOK) Code added in v0.95.0

func (o *CreateBoxOK) Code() int

Code gets the status code for the create box o k response

func (*CreateBoxOK) Error

func (o *CreateBoxOK) Error() string

func (*CreateBoxOK) GetPayload

func (*CreateBoxOK) IsClientError added in v0.23.0

func (o *CreateBoxOK) IsClientError() bool

IsClientError returns true when this create box o k response has a 4xx status code

func (*CreateBoxOK) IsCode added in v0.23.0

func (o *CreateBoxOK) IsCode(code int) bool

IsCode returns true when this create box o k response a status code equal to that given

func (*CreateBoxOK) IsRedirect added in v0.23.0

func (o *CreateBoxOK) IsRedirect() bool

IsRedirect returns true when this create box o k response has a 3xx status code

func (*CreateBoxOK) IsServerError added in v0.23.0

func (o *CreateBoxOK) IsServerError() bool

IsServerError returns true when this create box o k response has a 5xx status code

func (*CreateBoxOK) IsSuccess added in v0.23.0

func (o *CreateBoxOK) IsSuccess() bool

IsSuccess returns true when this create box o k response has a 2xx status code

func (*CreateBoxOK) String added in v0.23.0

func (o *CreateBoxOK) String() string

type CreateBoxParams

type CreateBoxParams struct {

	// Body.
	Body CreateBoxBody

	/* Registry.

	     The Registry segment of the Box. As an example, this field would represent
	the "hashicorp" in "hashicorp/vagrant".
	*/
	Registry string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

CreateBoxParams contains all the parameters to send to the API endpoint

for the create box operation.

Typically these are written to a http.Request.

func NewCreateBoxParams

func NewCreateBoxParams() *CreateBoxParams

NewCreateBoxParams creates a new CreateBoxParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewCreateBoxParamsWithContext

func NewCreateBoxParamsWithContext(ctx context.Context) *CreateBoxParams

NewCreateBoxParamsWithContext creates a new CreateBoxParams object with the ability to set a context for a request.

func NewCreateBoxParamsWithHTTPClient

func NewCreateBoxParamsWithHTTPClient(client *http.Client) *CreateBoxParams

NewCreateBoxParamsWithHTTPClient creates a new CreateBoxParams object with the ability to set a custom HTTPClient for a request.

func NewCreateBoxParamsWithTimeout

func NewCreateBoxParamsWithTimeout(timeout time.Duration) *CreateBoxParams

NewCreateBoxParamsWithTimeout creates a new CreateBoxParams object with the ability to set a timeout on a request.

func (*CreateBoxParams) SetBody

func (o *CreateBoxParams) SetBody(body CreateBoxBody)

SetBody adds the body to the create box params

func (*CreateBoxParams) SetContext

func (o *CreateBoxParams) SetContext(ctx context.Context)

SetContext adds the context to the create box params

func (*CreateBoxParams) SetDefaults added in v0.23.0

func (o *CreateBoxParams) SetDefaults()

SetDefaults hydrates default values in the create box params (not the query body).

All values with no default are reset to their zero value.

func (*CreateBoxParams) SetHTTPClient

func (o *CreateBoxParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the create box params

func (*CreateBoxParams) SetRegistry

func (o *CreateBoxParams) SetRegistry(registry string)

SetRegistry adds the registry to the create box params

func (*CreateBoxParams) SetTimeout

func (o *CreateBoxParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the create box params

func (*CreateBoxParams) WithBody

func (o *CreateBoxParams) WithBody(body CreateBoxBody) *CreateBoxParams

WithBody adds the body to the create box params

func (*CreateBoxParams) WithContext

func (o *CreateBoxParams) WithContext(ctx context.Context) *CreateBoxParams

WithContext adds the context to the create box params

func (*CreateBoxParams) WithDefaults added in v0.23.0

func (o *CreateBoxParams) WithDefaults() *CreateBoxParams

WithDefaults hydrates default values in the create box params (not the query body).

All values with no default are reset to their zero value.

func (*CreateBoxParams) WithHTTPClient

func (o *CreateBoxParams) WithHTTPClient(client *http.Client) *CreateBoxParams

WithHTTPClient adds the HTTPClient to the create box params

func (*CreateBoxParams) WithRegistry

func (o *CreateBoxParams) WithRegistry(registry string) *CreateBoxParams

WithRegistry adds the registry to the create box params

func (*CreateBoxParams) WithTimeout

func (o *CreateBoxParams) WithTimeout(timeout time.Duration) *CreateBoxParams

WithTimeout adds the timeout to the create box params

func (*CreateBoxParams) WriteToRequest

func (o *CreateBoxParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type CreateBoxReader

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

CreateBoxReader is a Reader for the CreateBox structure.

func (*CreateBoxReader) ReadResponse

func (o *CreateBoxReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DeleteBoxDefault added in v0.95.0

type DeleteBoxDefault struct {
	Payload *cloud.GoogleRPCStatus
	// contains filtered or unexported fields
}

DeleteBoxDefault describes a response with status code -1, with default header values.

An unexpected error response.

func NewDeleteBoxDefault added in v0.95.0

func NewDeleteBoxDefault(code int) *DeleteBoxDefault

NewDeleteBoxDefault creates a DeleteBoxDefault with default headers values

func (*DeleteBoxDefault) Code added in v0.95.0

func (o *DeleteBoxDefault) Code() int

Code gets the status code for the delete box default response

func (*DeleteBoxDefault) Error added in v0.95.0

func (o *DeleteBoxDefault) Error() string

func (*DeleteBoxDefault) GetPayload added in v0.95.0

func (o *DeleteBoxDefault) GetPayload() *cloud.GoogleRPCStatus

func (*DeleteBoxDefault) IsClientError added in v0.95.0

func (o *DeleteBoxDefault) IsClientError() bool

IsClientError returns true when this delete box default response has a 4xx status code

func (*DeleteBoxDefault) IsCode added in v0.95.0

func (o *DeleteBoxDefault) IsCode(code int) bool

IsCode returns true when this delete box default response a status code equal to that given

func (*DeleteBoxDefault) IsRedirect added in v0.95.0

func (o *DeleteBoxDefault) IsRedirect() bool

IsRedirect returns true when this delete box default response has a 3xx status code

func (*DeleteBoxDefault) IsServerError added in v0.95.0

func (o *DeleteBoxDefault) IsServerError() bool

IsServerError returns true when this delete box default response has a 5xx status code

func (*DeleteBoxDefault) IsSuccess added in v0.95.0

func (o *DeleteBoxDefault) IsSuccess() bool

IsSuccess returns true when this delete box default response has a 2xx status code

func (*DeleteBoxDefault) String added in v0.95.0

func (o *DeleteBoxDefault) String() string

type DeleteBoxOK

type DeleteBoxOK struct {
	Payload *models.HashicorpCloudVagrant20220930DeleteBoxResponse
}

DeleteBoxOK describes a response with status code 200, with default header values.

A successful response.

func NewDeleteBoxOK

func NewDeleteBoxOK() *DeleteBoxOK

NewDeleteBoxOK creates a DeleteBoxOK with default headers values

func (*DeleteBoxOK) Code added in v0.95.0

func (o *DeleteBoxOK) Code() int

Code gets the status code for the delete box o k response

func (*DeleteBoxOK) Error

func (o *DeleteBoxOK) Error() string

func (*DeleteBoxOK) GetPayload

func (*DeleteBoxOK) IsClientError added in v0.23.0

func (o *DeleteBoxOK) IsClientError() bool

IsClientError returns true when this delete box o k response has a 4xx status code

func (*DeleteBoxOK) IsCode added in v0.23.0

func (o *DeleteBoxOK) IsCode(code int) bool

IsCode returns true when this delete box o k response a status code equal to that given

func (*DeleteBoxOK) IsRedirect added in v0.23.0

func (o *DeleteBoxOK) IsRedirect() bool

IsRedirect returns true when this delete box o k response has a 3xx status code

func (*DeleteBoxOK) IsServerError added in v0.23.0

func (o *DeleteBoxOK) IsServerError() bool

IsServerError returns true when this delete box o k response has a 5xx status code

func (*DeleteBoxOK) IsSuccess added in v0.23.0

func (o *DeleteBoxOK) IsSuccess() bool

IsSuccess returns true when this delete box o k response has a 2xx status code

func (*DeleteBoxOK) String added in v0.23.0

func (o *DeleteBoxOK) String() string

type DeleteBoxParams

type DeleteBoxParams struct {

	/* Box.

	     The name segment of the Box to delete. As an example, this field would
	represent the "vagrant" in "hashicorp/vagrant".
	*/
	Box string

	/* Registry.

	     The Registry segment of the Box. As an example, this field would represent
	the "hashicorp" in "hashicorp/vagrant".
	*/
	Registry string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DeleteBoxParams contains all the parameters to send to the API endpoint

for the delete box operation.

Typically these are written to a http.Request.

func NewDeleteBoxParams

func NewDeleteBoxParams() *DeleteBoxParams

NewDeleteBoxParams creates a new DeleteBoxParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewDeleteBoxParamsWithContext

func NewDeleteBoxParamsWithContext(ctx context.Context) *DeleteBoxParams

NewDeleteBoxParamsWithContext creates a new DeleteBoxParams object with the ability to set a context for a request.

func NewDeleteBoxParamsWithHTTPClient

func NewDeleteBoxParamsWithHTTPClient(client *http.Client) *DeleteBoxParams

NewDeleteBoxParamsWithHTTPClient creates a new DeleteBoxParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteBoxParamsWithTimeout

func NewDeleteBoxParamsWithTimeout(timeout time.Duration) *DeleteBoxParams

NewDeleteBoxParamsWithTimeout creates a new DeleteBoxParams object with the ability to set a timeout on a request.

func (*DeleteBoxParams) SetBox

func (o *DeleteBoxParams) SetBox(box string)

SetBox adds the box to the delete box params

func (*DeleteBoxParams) SetContext

func (o *DeleteBoxParams) SetContext(ctx context.Context)

SetContext adds the context to the delete box params

func (*DeleteBoxParams) SetDefaults added in v0.23.0

func (o *DeleteBoxParams) SetDefaults()

SetDefaults hydrates default values in the delete box params (not the query body).

All values with no default are reset to their zero value.

func (*DeleteBoxParams) SetHTTPClient

func (o *DeleteBoxParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the delete box params

func (*DeleteBoxParams) SetRegistry

func (o *DeleteBoxParams) SetRegistry(registry string)

SetRegistry adds the registry to the delete box params

func (*DeleteBoxParams) SetTimeout

func (o *DeleteBoxParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the delete box params

func (*DeleteBoxParams) WithBox

func (o *DeleteBoxParams) WithBox(box string) *DeleteBoxParams

WithBox adds the box to the delete box params

func (*DeleteBoxParams) WithContext

func (o *DeleteBoxParams) WithContext(ctx context.Context) *DeleteBoxParams

WithContext adds the context to the delete box params

func (*DeleteBoxParams) WithDefaults added in v0.23.0

func (o *DeleteBoxParams) WithDefaults() *DeleteBoxParams

WithDefaults hydrates default values in the delete box params (not the query body).

All values with no default are reset to their zero value.

func (*DeleteBoxParams) WithHTTPClient

func (o *DeleteBoxParams) WithHTTPClient(client *http.Client) *DeleteBoxParams

WithHTTPClient adds the HTTPClient to the delete box params

func (*DeleteBoxParams) WithRegistry

func (o *DeleteBoxParams) WithRegistry(registry string) *DeleteBoxParams

WithRegistry adds the registry to the delete box params

func (*DeleteBoxParams) WithTimeout

func (o *DeleteBoxParams) WithTimeout(timeout time.Duration) *DeleteBoxParams

WithTimeout adds the timeout to the delete box params

func (*DeleteBoxParams) WriteToRequest

func (o *DeleteBoxParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DeleteBoxReader

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

DeleteBoxReader is a Reader for the DeleteBox structure.

func (*DeleteBoxReader) ReadResponse

func (o *DeleteBoxReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListBoxesDefault added in v0.95.0

type ListBoxesDefault struct {
	Payload *cloud.GoogleRPCStatus
	// contains filtered or unexported fields
}

ListBoxesDefault describes a response with status code -1, with default header values.

An unexpected error response.

func NewListBoxesDefault added in v0.95.0

func NewListBoxesDefault(code int) *ListBoxesDefault

NewListBoxesDefault creates a ListBoxesDefault with default headers values

func (*ListBoxesDefault) Code added in v0.95.0

func (o *ListBoxesDefault) Code() int

Code gets the status code for the list boxes default response

func (*ListBoxesDefault) Error added in v0.95.0

func (o *ListBoxesDefault) Error() string

func (*ListBoxesDefault) GetPayload added in v0.95.0

func (o *ListBoxesDefault) GetPayload() *cloud.GoogleRPCStatus

func (*ListBoxesDefault) IsClientError added in v0.95.0

func (o *ListBoxesDefault) IsClientError() bool

IsClientError returns true when this list boxes default response has a 4xx status code

func (*ListBoxesDefault) IsCode added in v0.95.0

func (o *ListBoxesDefault) IsCode(code int) bool

IsCode returns true when this list boxes default response a status code equal to that given

func (*ListBoxesDefault) IsRedirect added in v0.95.0

func (o *ListBoxesDefault) IsRedirect() bool

IsRedirect returns true when this list boxes default response has a 3xx status code

func (*ListBoxesDefault) IsServerError added in v0.95.0

func (o *ListBoxesDefault) IsServerError() bool

IsServerError returns true when this list boxes default response has a 5xx status code

func (*ListBoxesDefault) IsSuccess added in v0.95.0

func (o *ListBoxesDefault) IsSuccess() bool

IsSuccess returns true when this list boxes default response has a 2xx status code

func (*ListBoxesDefault) String added in v0.95.0

func (o *ListBoxesDefault) String() string

type ListBoxesOK

type ListBoxesOK struct {
	Payload *models.HashicorpCloudVagrant20220930ListBoxesResponse
}

ListBoxesOK describes a response with status code 200, with default header values.

A successful response.

func NewListBoxesOK

func NewListBoxesOK() *ListBoxesOK

NewListBoxesOK creates a ListBoxesOK with default headers values

func (*ListBoxesOK) Code added in v0.95.0

func (o *ListBoxesOK) Code() int

Code gets the status code for the list boxes o k response

func (*ListBoxesOK) Error

func (o *ListBoxesOK) Error() string

func (*ListBoxesOK) GetPayload

func (*ListBoxesOK) IsClientError added in v0.23.0

func (o *ListBoxesOK) IsClientError() bool

IsClientError returns true when this list boxes o k response has a 4xx status code

func (*ListBoxesOK) IsCode added in v0.23.0

func (o *ListBoxesOK) IsCode(code int) bool

IsCode returns true when this list boxes o k response a status code equal to that given

func (*ListBoxesOK) IsRedirect added in v0.23.0

func (o *ListBoxesOK) IsRedirect() bool

IsRedirect returns true when this list boxes o k response has a 3xx status code

func (*ListBoxesOK) IsServerError added in v0.23.0

func (o *ListBoxesOK) IsServerError() bool

IsServerError returns true when this list boxes o k response has a 5xx status code

func (*ListBoxesOK) IsSuccess added in v0.23.0

func (o *ListBoxesOK) IsSuccess() bool

IsSuccess returns true when this list boxes o k response has a 2xx status code

func (*ListBoxesOK) String added in v0.23.0

func (o *ListBoxesOK) String() string

type ListBoxesParams

type ListBoxesParams struct {

	/* PaginationNextPageToken.

	     Specifies a page token to use to retrieve the next page. Set this to the
	`next_page_token` returned by previous list requests to get the next page of
	results. If set, `previous_page_token` must not be set.
	*/
	PaginationNextPageToken *string

	/* PaginationPageSize.

	     The max number of results per page that should be returned. If the number
	of available results is larger than `page_size`, a `next_page_token` is
	returned which can be used to get the next page of results in subsequent
	requests. A value of zero will cause `page_size` to be defaulted.

	     Format: int64
	*/
	PaginationPageSize *int64

	/* PaginationPreviousPageToken.

	     Specifies a page token to use to retrieve the previous page. Set this to
	the `previous_page_token` returned by previous list requests to get the
	previous page of results. If set, `next_page_token` must not be set.
	*/
	PaginationPreviousPageToken *string

	/* Registry.

	   The name of the Registry to list boxes in.
	*/
	Registry string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListBoxesParams contains all the parameters to send to the API endpoint

for the list boxes operation.

Typically these are written to a http.Request.

func NewListBoxesParams

func NewListBoxesParams() *ListBoxesParams

NewListBoxesParams creates a new ListBoxesParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewListBoxesParamsWithContext

func NewListBoxesParamsWithContext(ctx context.Context) *ListBoxesParams

NewListBoxesParamsWithContext creates a new ListBoxesParams object with the ability to set a context for a request.

func NewListBoxesParamsWithHTTPClient

func NewListBoxesParamsWithHTTPClient(client *http.Client) *ListBoxesParams

NewListBoxesParamsWithHTTPClient creates a new ListBoxesParams object with the ability to set a custom HTTPClient for a request.

func NewListBoxesParamsWithTimeout

func NewListBoxesParamsWithTimeout(timeout time.Duration) *ListBoxesParams

NewListBoxesParamsWithTimeout creates a new ListBoxesParams object with the ability to set a timeout on a request.

func (*ListBoxesParams) SetContext

func (o *ListBoxesParams) SetContext(ctx context.Context)

SetContext adds the context to the list boxes params

func (*ListBoxesParams) SetDefaults added in v0.23.0

func (o *ListBoxesParams) SetDefaults()

SetDefaults hydrates default values in the list boxes params (not the query body).

All values with no default are reset to their zero value.

func (*ListBoxesParams) SetHTTPClient

func (o *ListBoxesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list boxes params

func (*ListBoxesParams) SetPaginationNextPageToken

func (o *ListBoxesParams) SetPaginationNextPageToken(paginationNextPageToken *string)

SetPaginationNextPageToken adds the paginationNextPageToken to the list boxes params

func (*ListBoxesParams) SetPaginationPageSize

func (o *ListBoxesParams) SetPaginationPageSize(paginationPageSize *int64)

SetPaginationPageSize adds the paginationPageSize to the list boxes params

func (*ListBoxesParams) SetPaginationPreviousPageToken

func (o *ListBoxesParams) SetPaginationPreviousPageToken(paginationPreviousPageToken *string)

SetPaginationPreviousPageToken adds the paginationPreviousPageToken to the list boxes params

func (*ListBoxesParams) SetRegistry

func (o *ListBoxesParams) SetRegistry(registry string)

SetRegistry adds the registry to the list boxes params

func (*ListBoxesParams) SetTimeout

func (o *ListBoxesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list boxes params

func (*ListBoxesParams) WithContext

func (o *ListBoxesParams) WithContext(ctx context.Context) *ListBoxesParams

WithContext adds the context to the list boxes params

func (*ListBoxesParams) WithDefaults added in v0.23.0

func (o *ListBoxesParams) WithDefaults() *ListBoxesParams

WithDefaults hydrates default values in the list boxes params (not the query body).

All values with no default are reset to their zero value.

func (*ListBoxesParams) WithHTTPClient

func (o *ListBoxesParams) WithHTTPClient(client *http.Client) *ListBoxesParams

WithHTTPClient adds the HTTPClient to the list boxes params

func (*ListBoxesParams) WithPaginationNextPageToken

func (o *ListBoxesParams) WithPaginationNextPageToken(paginationNextPageToken *string) *ListBoxesParams

WithPaginationNextPageToken adds the paginationNextPageToken to the list boxes params

func (*ListBoxesParams) WithPaginationPageSize

func (o *ListBoxesParams) WithPaginationPageSize(paginationPageSize *int64) *ListBoxesParams

WithPaginationPageSize adds the paginationPageSize to the list boxes params

func (*ListBoxesParams) WithPaginationPreviousPageToken

func (o *ListBoxesParams) WithPaginationPreviousPageToken(paginationPreviousPageToken *string) *ListBoxesParams

WithPaginationPreviousPageToken adds the paginationPreviousPageToken to the list boxes params

func (*ListBoxesParams) WithRegistry

func (o *ListBoxesParams) WithRegistry(registry string) *ListBoxesParams

WithRegistry adds the registry to the list boxes params

func (*ListBoxesParams) WithTimeout

func (o *ListBoxesParams) WithTimeout(timeout time.Duration) *ListBoxesParams

WithTimeout adds the timeout to the list boxes params

func (*ListBoxesParams) WriteToRequest

func (o *ListBoxesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListBoxesReader

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

ListBoxesReader is a Reader for the ListBoxes structure.

func (*ListBoxesReader) ReadResponse

func (o *ListBoxesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ReadBoxDefault added in v0.95.0

type ReadBoxDefault struct {
	Payload *cloud.GoogleRPCStatus
	// contains filtered or unexported fields
}

ReadBoxDefault describes a response with status code -1, with default header values.

An unexpected error response.

func NewReadBoxDefault added in v0.95.0

func NewReadBoxDefault(code int) *ReadBoxDefault

NewReadBoxDefault creates a ReadBoxDefault with default headers values

func (*ReadBoxDefault) Code added in v0.95.0

func (o *ReadBoxDefault) Code() int

Code gets the status code for the read box default response

func (*ReadBoxDefault) Error added in v0.95.0

func (o *ReadBoxDefault) Error() string

func (*ReadBoxDefault) GetPayload added in v0.95.0

func (o *ReadBoxDefault) GetPayload() *cloud.GoogleRPCStatus

func (*ReadBoxDefault) IsClientError added in v0.95.0

func (o *ReadBoxDefault) IsClientError() bool

IsClientError returns true when this read box default response has a 4xx status code

func (*ReadBoxDefault) IsCode added in v0.95.0

func (o *ReadBoxDefault) IsCode(code int) bool

IsCode returns true when this read box default response a status code equal to that given

func (*ReadBoxDefault) IsRedirect added in v0.95.0

func (o *ReadBoxDefault) IsRedirect() bool

IsRedirect returns true when this read box default response has a 3xx status code

func (*ReadBoxDefault) IsServerError added in v0.95.0

func (o *ReadBoxDefault) IsServerError() bool

IsServerError returns true when this read box default response has a 5xx status code

func (*ReadBoxDefault) IsSuccess added in v0.95.0

func (o *ReadBoxDefault) IsSuccess() bool

IsSuccess returns true when this read box default response has a 2xx status code

func (*ReadBoxDefault) String added in v0.95.0

func (o *ReadBoxDefault) String() string

type ReadBoxOK

type ReadBoxOK struct {
	Payload *models.HashicorpCloudVagrant20220930ReadBoxResponse
}

ReadBoxOK describes a response with status code 200, with default header values.

A successful response.

func NewReadBoxOK

func NewReadBoxOK() *ReadBoxOK

NewReadBoxOK creates a ReadBoxOK with default headers values

func (*ReadBoxOK) Code added in v0.95.0

func (o *ReadBoxOK) Code() int

Code gets the status code for the read box o k response

func (*ReadBoxOK) Error

func (o *ReadBoxOK) Error() string

func (*ReadBoxOK) GetPayload

func (*ReadBoxOK) IsClientError added in v0.23.0

func (o *ReadBoxOK) IsClientError() bool

IsClientError returns true when this read box o k response has a 4xx status code

func (*ReadBoxOK) IsCode added in v0.23.0

func (o *ReadBoxOK) IsCode(code int) bool

IsCode returns true when this read box o k response a status code equal to that given

func (*ReadBoxOK) IsRedirect added in v0.23.0

func (o *ReadBoxOK) IsRedirect() bool

IsRedirect returns true when this read box o k response has a 3xx status code

func (*ReadBoxOK) IsServerError added in v0.23.0

func (o *ReadBoxOK) IsServerError() bool

IsServerError returns true when this read box o k response has a 5xx status code

func (*ReadBoxOK) IsSuccess added in v0.23.0

func (o *ReadBoxOK) IsSuccess() bool

IsSuccess returns true when this read box o k response has a 2xx status code

func (*ReadBoxOK) String added in v0.23.0

func (o *ReadBoxOK) String() string

type ReadBoxParams

type ReadBoxParams struct {

	/* Box.

	     The name segment of the Box to look up. As an example, this field would
	represent the "vagrant" in "hashicorp/vagrant".
	*/
	Box string

	/* Registry.

	     The Registry segment of the Box. As an example, this field would represent
	the "hashicorp" in "hashicorp/vagrant".
	*/
	Registry string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ReadBoxParams contains all the parameters to send to the API endpoint

for the read box operation.

Typically these are written to a http.Request.

func NewReadBoxParams

func NewReadBoxParams() *ReadBoxParams

NewReadBoxParams creates a new ReadBoxParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewReadBoxParamsWithContext

func NewReadBoxParamsWithContext(ctx context.Context) *ReadBoxParams

NewReadBoxParamsWithContext creates a new ReadBoxParams object with the ability to set a context for a request.

func NewReadBoxParamsWithHTTPClient

func NewReadBoxParamsWithHTTPClient(client *http.Client) *ReadBoxParams

NewReadBoxParamsWithHTTPClient creates a new ReadBoxParams object with the ability to set a custom HTTPClient for a request.

func NewReadBoxParamsWithTimeout

func NewReadBoxParamsWithTimeout(timeout time.Duration) *ReadBoxParams

NewReadBoxParamsWithTimeout creates a new ReadBoxParams object with the ability to set a timeout on a request.

func (*ReadBoxParams) SetBox

func (o *ReadBoxParams) SetBox(box string)

SetBox adds the box to the read box params

func (*ReadBoxParams) SetContext

func (o *ReadBoxParams) SetContext(ctx context.Context)

SetContext adds the context to the read box params

func (*ReadBoxParams) SetDefaults added in v0.23.0

func (o *ReadBoxParams) SetDefaults()

SetDefaults hydrates default values in the read box params (not the query body).

All values with no default are reset to their zero value.

func (*ReadBoxParams) SetHTTPClient

func (o *ReadBoxParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the read box params

func (*ReadBoxParams) SetRegistry

func (o *ReadBoxParams) SetRegistry(registry string)

SetRegistry adds the registry to the read box params

func (*ReadBoxParams) SetTimeout

func (o *ReadBoxParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the read box params

func (*ReadBoxParams) WithBox

func (o *ReadBoxParams) WithBox(box string) *ReadBoxParams

WithBox adds the box to the read box params

func (*ReadBoxParams) WithContext

func (o *ReadBoxParams) WithContext(ctx context.Context) *ReadBoxParams

WithContext adds the context to the read box params

func (*ReadBoxParams) WithDefaults added in v0.23.0

func (o *ReadBoxParams) WithDefaults() *ReadBoxParams

WithDefaults hydrates default values in the read box params (not the query body).

All values with no default are reset to their zero value.

func (*ReadBoxParams) WithHTTPClient

func (o *ReadBoxParams) WithHTTPClient(client *http.Client) *ReadBoxParams

WithHTTPClient adds the HTTPClient to the read box params

func (*ReadBoxParams) WithRegistry

func (o *ReadBoxParams) WithRegistry(registry string) *ReadBoxParams

WithRegistry adds the registry to the read box params

func (*ReadBoxParams) WithTimeout

func (o *ReadBoxParams) WithTimeout(timeout time.Duration) *ReadBoxParams

WithTimeout adds the timeout to the read box params

func (*ReadBoxParams) WriteToRequest

func (o *ReadBoxParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ReadBoxReader

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

ReadBoxReader is a Reader for the ReadBox structure.

func (*ReadBoxReader) ReadResponse

func (o *ReadBoxReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type UpdateBoxBody added in v0.95.0

type UpdateBoxBody struct {

	// Details of the Box to update. Note that some fields are ignored
	// on input and should not be set.
	Data *models.HashicorpCloudVagrant20220930Box `json:"data,omitempty"`
}

UpdateBoxBody update box body swagger:model UpdateBoxBody

func (*UpdateBoxBody) ContextValidate added in v0.95.0

func (o *UpdateBoxBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this update box body based on the context it is used

func (*UpdateBoxBody) MarshalBinary added in v0.95.0

func (o *UpdateBoxBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateBoxBody) UnmarshalBinary added in v0.95.0

func (o *UpdateBoxBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateBoxBody) Validate added in v0.95.0

func (o *UpdateBoxBody) Validate(formats strfmt.Registry) error

Validate validates this update box body

type UpdateBoxDefault added in v0.95.0

type UpdateBoxDefault struct {
	Payload *cloud.GoogleRPCStatus
	// contains filtered or unexported fields
}

UpdateBoxDefault describes a response with status code -1, with default header values.

An unexpected error response.

func NewUpdateBoxDefault added in v0.95.0

func NewUpdateBoxDefault(code int) *UpdateBoxDefault

NewUpdateBoxDefault creates a UpdateBoxDefault with default headers values

func (*UpdateBoxDefault) Code added in v0.95.0

func (o *UpdateBoxDefault) Code() int

Code gets the status code for the update box default response

func (*UpdateBoxDefault) Error added in v0.95.0

func (o *UpdateBoxDefault) Error() string

func (*UpdateBoxDefault) GetPayload added in v0.95.0

func (o *UpdateBoxDefault) GetPayload() *cloud.GoogleRPCStatus

func (*UpdateBoxDefault) IsClientError added in v0.95.0

func (o *UpdateBoxDefault) IsClientError() bool

IsClientError returns true when this update box default response has a 4xx status code

func (*UpdateBoxDefault) IsCode added in v0.95.0

func (o *UpdateBoxDefault) IsCode(code int) bool

IsCode returns true when this update box default response a status code equal to that given

func (*UpdateBoxDefault) IsRedirect added in v0.95.0

func (o *UpdateBoxDefault) IsRedirect() bool

IsRedirect returns true when this update box default response has a 3xx status code

func (*UpdateBoxDefault) IsServerError added in v0.95.0

func (o *UpdateBoxDefault) IsServerError() bool

IsServerError returns true when this update box default response has a 5xx status code

func (*UpdateBoxDefault) IsSuccess added in v0.95.0

func (o *UpdateBoxDefault) IsSuccess() bool

IsSuccess returns true when this update box default response has a 2xx status code

func (*UpdateBoxDefault) String added in v0.95.0

func (o *UpdateBoxDefault) String() string

type UpdateBoxOK

type UpdateBoxOK struct {
	Payload *models.HashicorpCloudVagrant20220930UpdateBoxResponse
}

UpdateBoxOK describes a response with status code 200, with default header values.

A successful response.

func NewUpdateBoxOK

func NewUpdateBoxOK() *UpdateBoxOK

NewUpdateBoxOK creates a UpdateBoxOK with default headers values

func (*UpdateBoxOK) Code added in v0.95.0

func (o *UpdateBoxOK) Code() int

Code gets the status code for the update box o k response

func (*UpdateBoxOK) Error

func (o *UpdateBoxOK) Error() string

func (*UpdateBoxOK) GetPayload

func (*UpdateBoxOK) IsClientError added in v0.23.0

func (o *UpdateBoxOK) IsClientError() bool

IsClientError returns true when this update box o k response has a 4xx status code

func (*UpdateBoxOK) IsCode added in v0.23.0

func (o *UpdateBoxOK) IsCode(code int) bool

IsCode returns true when this update box o k response a status code equal to that given

func (*UpdateBoxOK) IsRedirect added in v0.23.0

func (o *UpdateBoxOK) IsRedirect() bool

IsRedirect returns true when this update box o k response has a 3xx status code

func (*UpdateBoxOK) IsServerError added in v0.23.0

func (o *UpdateBoxOK) IsServerError() bool

IsServerError returns true when this update box o k response has a 5xx status code

func (*UpdateBoxOK) IsSuccess added in v0.23.0

func (o *UpdateBoxOK) IsSuccess() bool

IsSuccess returns true when this update box o k response has a 2xx status code

func (*UpdateBoxOK) String added in v0.23.0

func (o *UpdateBoxOK) String() string

type UpdateBoxParams

type UpdateBoxParams struct {

	// Body.
	Body UpdateBoxBody

	/* Box.

	     The name segment of the Box to update. As an example, this field would
	represent the "vagrant" in "hashicorp/vagrant".
	*/
	Box string

	/* Registry.

	     The Registry segment of the Box. As an example, this field would represent
	the "hashicorp" in "hashicorp/vagrant".
	*/
	Registry string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

UpdateBoxParams contains all the parameters to send to the API endpoint

for the update box operation.

Typically these are written to a http.Request.

func NewUpdateBoxParams

func NewUpdateBoxParams() *UpdateBoxParams

NewUpdateBoxParams creates a new UpdateBoxParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewUpdateBoxParamsWithContext

func NewUpdateBoxParamsWithContext(ctx context.Context) *UpdateBoxParams

NewUpdateBoxParamsWithContext creates a new UpdateBoxParams object with the ability to set a context for a request.

func NewUpdateBoxParamsWithHTTPClient

func NewUpdateBoxParamsWithHTTPClient(client *http.Client) *UpdateBoxParams

NewUpdateBoxParamsWithHTTPClient creates a new UpdateBoxParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateBoxParamsWithTimeout

func NewUpdateBoxParamsWithTimeout(timeout time.Duration) *UpdateBoxParams

NewUpdateBoxParamsWithTimeout creates a new UpdateBoxParams object with the ability to set a timeout on a request.

func (*UpdateBoxParams) SetBody

func (o *UpdateBoxParams) SetBody(body UpdateBoxBody)

SetBody adds the body to the update box params

func (*UpdateBoxParams) SetBox

func (o *UpdateBoxParams) SetBox(box string)

SetBox adds the box to the update box params

func (*UpdateBoxParams) SetContext

func (o *UpdateBoxParams) SetContext(ctx context.Context)

SetContext adds the context to the update box params

func (*UpdateBoxParams) SetDefaults added in v0.23.0

func (o *UpdateBoxParams) SetDefaults()

SetDefaults hydrates default values in the update box params (not the query body).

All values with no default are reset to their zero value.

func (*UpdateBoxParams) SetHTTPClient

func (o *UpdateBoxParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the update box params

func (*UpdateBoxParams) SetRegistry

func (o *UpdateBoxParams) SetRegistry(registry string)

SetRegistry adds the registry to the update box params

func (*UpdateBoxParams) SetTimeout

func (o *UpdateBoxParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the update box params

func (*UpdateBoxParams) WithBody

func (o *UpdateBoxParams) WithBody(body UpdateBoxBody) *UpdateBoxParams

WithBody adds the body to the update box params

func (*UpdateBoxParams) WithBox

func (o *UpdateBoxParams) WithBox(box string) *UpdateBoxParams

WithBox adds the box to the update box params

func (*UpdateBoxParams) WithContext

func (o *UpdateBoxParams) WithContext(ctx context.Context) *UpdateBoxParams

WithContext adds the context to the update box params

func (*UpdateBoxParams) WithDefaults added in v0.23.0

func (o *UpdateBoxParams) WithDefaults() *UpdateBoxParams

WithDefaults hydrates default values in the update box params (not the query body).

All values with no default are reset to their zero value.

func (*UpdateBoxParams) WithHTTPClient

func (o *UpdateBoxParams) WithHTTPClient(client *http.Client) *UpdateBoxParams

WithHTTPClient adds the HTTPClient to the update box params

func (*UpdateBoxParams) WithRegistry

func (o *UpdateBoxParams) WithRegistry(registry string) *UpdateBoxParams

WithRegistry adds the registry to the update box params

func (*UpdateBoxParams) WithTimeout

func (o *UpdateBoxParams) WithTimeout(timeout time.Duration) *UpdateBoxParams

WithTimeout adds the timeout to the update box params

func (*UpdateBoxParams) WriteToRequest

func (o *UpdateBoxParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type UpdateBoxReader

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

UpdateBoxReader is a Reader for the UpdateBox structure.

func (*UpdateBoxReader) ReadResponse

func (o *UpdateBoxReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL