operation_service

package
v0.94.0 Latest Latest
Warning

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

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

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 operation service API

func (*Client) Get 

func (a *Client) Get(params *GetParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetOK, error)
Get gets returns the latest state of a specific operation

The Location's organization and project IDs are included in the path in

order to support RBAC checks. We perform RBAC checks early in the request lifecycle, before loading the resource targeted by the request.

func (*Client) List 

func (a *Client) List(params *ListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListOK, error)
List lists selects a list of operations that match some filters and then returns them in the response

The supported filters are the Location's organization_id and project_id.

The project_id supports the special value "-" to allow requesting operations that match any project within the organization.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) Wait 

func (a *Client) Wait(params *WaitParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*WaitOK, error)
Wait waits blocks until an operation is d o n e or a timeout is reached whichever occurs first it then returns the latest state of the operation that it had at the time of the timeout

Note that Wait may return at any time. In most cases, the timeout will

be respected but it isn't guaranteed. Therefore, clients should always check the state of the returned operation. A return from Wait does not guarantee the operation is DONE.

The Location's organization and project IDs are included in the path in order to support RBAC checks. We perform RBAC checks early in the request lifecycle, before loading the resource targeted by the request.

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	Get(params *GetParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetOK, error)

	List(params *ListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListOK, error)

	Wait(params *WaitParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*WaitOK, 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 operation service API client.

type GetDefault 

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

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

An unexpected error response.

func NewGetDefault 

func NewGetDefault(code int) *GetDefault

NewGetDefault creates a GetDefault with default headers values

func (*GetDefault) Code 

func (o *GetDefault) Code() int

Code gets the status code for the get default response

func (*GetDefault) Error 

func (o *GetDefault) Error() string

func (*GetDefault) GetPayload 

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

func (*GetDefault) IsClientError 

func (o *GetDefault) IsClientError() bool

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

func (*GetDefault) IsCode 

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

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

func (*GetDefault) IsRedirect 

func (o *GetDefault) IsRedirect() bool

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

func (*GetDefault) IsServerError 

func (o *GetDefault) IsServerError() bool

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

func (*GetDefault) IsSuccess 

func (o *GetDefault) IsSuccess() bool

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

func (*GetDefault) String 

func (o *GetDefault) String() string

type GetOK 

type GetOK struct {
	Payload *models.HashicorpCloudOperationGetResponse
}

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

A successful response.

func NewGetOK 

func NewGetOK() *GetOK

NewGetOK creates a GetOK with default headers values

func (*GetOK) Error 

func (o *GetOK) Error() string

func (*GetOK) GetPayload 

func (o *GetOK) GetPayload() *models.HashicorpCloudOperationGetResponse

func (*GetOK) IsClientError 

func (o *GetOK) IsClientError() bool

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

func (*GetOK) IsCode 

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

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

func (*GetOK) IsRedirect 

func (o *GetOK) IsRedirect() bool

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

func (*GetOK) IsServerError 

func (o *GetOK) IsServerError() bool

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

func (*GetOK) IsSuccess 

func (o *GetOK) IsSuccess() bool

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

func (*GetOK) String 

func (o *GetOK) String() string

type GetParams 

type GetParams struct {

	/* ID.

	   id is the UUID of the operation.
	*/
	ID string

	/* LocationOrganizationID.

	   organization_id is the id of the organization.
	*/
	LocationOrganizationID string

	/* LocationProjectID.

	   project_id is the projects id.
	*/
	LocationProjectID string

	/* LocationRegionProvider.

	   provider is the named cloud provider ("aws", "gcp", "azure").
	*/
	LocationRegionProvider *string

	/* LocationRegionRegion.

	   region is the cloud region ("us-west1", "us-east1").
	*/
	LocationRegionRegion *string

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

GetParams contains all the parameters to send to the API endpoint 

for the get operation.

Typically these are written to a http.Request.

func NewGetParams 

func NewGetParams() *GetParams

NewGetParams creates a new GetParams 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 NewGetParamsWithContext 

func NewGetParamsWithContext(ctx context.Context) *GetParams

NewGetParamsWithContext creates a new GetParams object with the ability to set a context for a request.

func NewGetParamsWithHTTPClient 

func NewGetParamsWithHTTPClient(client *http.Client) *GetParams

NewGetParamsWithHTTPClient creates a new GetParams object with the ability to set a custom HTTPClient for a request.

func NewGetParamsWithTimeout 

func NewGetParamsWithTimeout(timeout time.Duration) *GetParams

NewGetParamsWithTimeout creates a new GetParams object with the ability to set a timeout on a request.

func (*GetParams) SetContext 

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

SetContext adds the context to the get params

func (*GetParams) SetDefaults 

func (o *GetParams) SetDefaults()

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

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

func (*GetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get params

func (*GetParams) SetID 

func (o *GetParams) SetID(id string)

SetID adds the id to the get params

func (*GetParams) SetLocationOrganizationID 

func (o *GetParams) SetLocationOrganizationID(locationOrganizationID string)

SetLocationOrganizationID adds the locationOrganizationId to the get params

func (*GetParams) SetLocationProjectID 

func (o *GetParams) SetLocationProjectID(locationProjectID string)

SetLocationProjectID adds the locationProjectId to the get params

func (*GetParams) SetLocationRegionProvider 

func (o *GetParams) SetLocationRegionProvider(locationRegionProvider *string)

SetLocationRegionProvider adds the locationRegionProvider to the get params

func (*GetParams) SetLocationRegionRegion 

func (o *GetParams) SetLocationRegionRegion(locationRegionRegion *string)

SetLocationRegionRegion adds the locationRegionRegion to the get params

func (*GetParams) SetTimeout 

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

SetTimeout adds the timeout to the get params

func (*GetParams) WithContext 

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

WithContext adds the context to the get params

func (*GetParams) WithDefaults 

func (o *GetParams) WithDefaults() *GetParams

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

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

func (*GetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get params

func (*GetParams) WithID 

func (o *GetParams) WithID(id string) *GetParams

WithID adds the id to the get params

func (*GetParams) WithLocationOrganizationID 

func (o *GetParams) WithLocationOrganizationID(locationOrganizationID string) *GetParams

WithLocationOrganizationID adds the locationOrganizationID to the get params

func (*GetParams) WithLocationProjectID 

func (o *GetParams) WithLocationProjectID(locationProjectID string) *GetParams

WithLocationProjectID adds the locationProjectID to the get params

func (*GetParams) WithLocationRegionProvider 

func (o *GetParams) WithLocationRegionProvider(locationRegionProvider *string) *GetParams

WithLocationRegionProvider adds the locationRegionProvider to the get params

func (*GetParams) WithLocationRegionRegion 

func (o *GetParams) WithLocationRegionRegion(locationRegionRegion *string) *GetParams

WithLocationRegionRegion adds the locationRegionRegion to the get params

func (*GetParams) WithTimeout 

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

WithTimeout adds the timeout to the get params

func (*GetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetReader 

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

GetReader is a Reader for the Get structure.

func (*GetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListDefault 

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

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

An unexpected error response.

func NewListDefault 

func NewListDefault(code int) *ListDefault

NewListDefault creates a ListDefault with default headers values

func (*ListDefault) Code 

func (o *ListDefault) Code() int

Code gets the status code for the list default response

func (*ListDefault) Error 

func (o *ListDefault) Error() string

func (*ListDefault) GetPayload 

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

func (*ListDefault) IsClientError 

func (o *ListDefault) IsClientError() bool

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

func (*ListDefault) IsCode 

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

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

func (*ListDefault) IsRedirect 

func (o *ListDefault) IsRedirect() bool

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

func (*ListDefault) IsServerError 

func (o *ListDefault) IsServerError() bool

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

func (*ListDefault) IsSuccess 

func (o *ListDefault) IsSuccess() bool

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

func (*ListDefault) String 

func (o *ListDefault) String() string

type ListOK 

type ListOK struct {
	Payload *models.HashicorpCloudOperationListResponse
}

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

A successful response.

func NewListOK 

func NewListOK() *ListOK

NewListOK creates a ListOK with default headers values

func (*ListOK) Error 

func (o *ListOK) Error() string

func (*ListOK) GetPayload 

func (o *ListOK) GetPayload() *models.HashicorpCloudOperationListResponse

func (*ListOK) IsClientError 

func (o *ListOK) IsClientError() bool

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

func (*ListOK) IsCode 

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

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

func (*ListOK) IsRedirect 

func (o *ListOK) IsRedirect() bool

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

func (*ListOK) IsServerError 

func (o *ListOK) IsServerError() bool

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

func (*ListOK) IsSuccess 

func (o *ListOK) IsSuccess() bool

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

func (*ListOK) String 

func (o *ListOK) String() string

type ListParams 

type ListParams struct {

	/* LinkedResourceDescription.

	     description is a human-friendly description for this link. This is
	used primarily for informational purposes such as error messages.
	*/
	LinkedResourceDescription *string

	/* LinkedResourceID.

	   id is the identifier for this resource.
	*/
	LinkedResourceID *string

	/* LinkedResourceLocationRegionProvider.

	   provider is the named cloud provider ("aws", "gcp", "azure").
	*/
	LinkedResourceLocationRegionProvider *string

	/* LinkedResourceLocationRegionRegion.

	   region is the cloud region ("us-west1", "us-east1").
	*/
	LinkedResourceLocationRegionRegion *string

	/* LinkedResourceType.

	     type is the unique type of the resource. Each service publishes a
	unique set of types. The type value is recommended to be formatted
	in "<org>.<type>" such as "hashicorp.hvn". This is to prevent conflicts
	in the future, but any string value will work.
	*/
	LinkedResourceType *string

	/* LinkedResourceUUID.

	   uuid is the unique UUID for this resource.
	*/
	LinkedResourceUUID *string

	/* LocationOrganizationID.

	   organization_id is the id of the organization.
	*/
	LocationOrganizationID string

	/* LocationProjectID.

	   project_id is the projects id.
	*/
	LocationProjectID string

	/* LocationRegionProvider.

	   provider is the named cloud provider ("aws", "gcp", "azure").
	*/
	LocationRegionProvider *string

	/* LocationRegionRegion.

	   region is the cloud region ("us-west1", "us-east1").
	*/
	LocationRegionRegion *string

	/* 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

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

ListParams contains all the parameters to send to the API endpoint 

for the list operation.

Typically these are written to a http.Request.

func NewListParams 

func NewListParams() *ListParams

NewListParams creates a new ListParams 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 NewListParamsWithContext 

func NewListParamsWithContext(ctx context.Context) *ListParams

NewListParamsWithContext creates a new ListParams object with the ability to set a context for a request.

func NewListParamsWithHTTPClient 

func NewListParamsWithHTTPClient(client *http.Client) *ListParams

NewListParamsWithHTTPClient creates a new ListParams object with the ability to set a custom HTTPClient for a request.

func NewListParamsWithTimeout 

func NewListParamsWithTimeout(timeout time.Duration) *ListParams

NewListParamsWithTimeout creates a new ListParams object with the ability to set a timeout on a request.

func (*ListParams) SetContext 

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

SetContext adds the context to the list params

func (*ListParams) SetDefaults 

func (o *ListParams) SetDefaults()

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

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

func (*ListParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list params

func (*ListParams) SetLinkedResourceDescription 

func (o *ListParams) SetLinkedResourceDescription(linkedResourceDescription *string)

SetLinkedResourceDescription adds the linkedResourceDescription to the list params

func (*ListParams) SetLinkedResourceID 

func (o *ListParams) SetLinkedResourceID(linkedResourceID *string)

SetLinkedResourceID adds the linkedResourceId to the list params

func (*ListParams) SetLinkedResourceLocationRegionProvider 

func (o *ListParams) SetLinkedResourceLocationRegionProvider(linkedResourceLocationRegionProvider *string)

SetLinkedResourceLocationRegionProvider adds the linkedResourceLocationRegionProvider to the list params

func (*ListParams) SetLinkedResourceLocationRegionRegion 

func (o *ListParams) SetLinkedResourceLocationRegionRegion(linkedResourceLocationRegionRegion *string)

SetLinkedResourceLocationRegionRegion adds the linkedResourceLocationRegionRegion to the list params

func (*ListParams) SetLinkedResourceType 

func (o *ListParams) SetLinkedResourceType(linkedResourceType *string)

SetLinkedResourceType adds the linkedResourceType to the list params

func (*ListParams) SetLinkedResourceUUID 

func (o *ListParams) SetLinkedResourceUUID(linkedResourceUUID *string)

SetLinkedResourceUUID adds the linkedResourceUuid to the list params

func (*ListParams) SetLocationOrganizationID 

func (o *ListParams) SetLocationOrganizationID(locationOrganizationID string)

SetLocationOrganizationID adds the locationOrganizationId to the list params

func (*ListParams) SetLocationProjectID 

func (o *ListParams) SetLocationProjectID(locationProjectID string)

SetLocationProjectID adds the locationProjectId to the list params

func (*ListParams) SetLocationRegionProvider 

func (o *ListParams) SetLocationRegionProvider(locationRegionProvider *string)

SetLocationRegionProvider adds the locationRegionProvider to the list params

func (*ListParams) SetLocationRegionRegion 

func (o *ListParams) SetLocationRegionRegion(locationRegionRegion *string)

SetLocationRegionRegion adds the locationRegionRegion to the list params

func (*ListParams) SetPaginationNextPageToken 

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

SetPaginationNextPageToken adds the paginationNextPageToken to the list params

func (*ListParams) SetPaginationPageSize 

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

SetPaginationPageSize adds the paginationPageSize to the list params

func (*ListParams) SetPaginationPreviousPageToken 

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

SetPaginationPreviousPageToken adds the paginationPreviousPageToken to the list params

func (*ListParams) SetTimeout 

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

SetTimeout adds the timeout to the list params

func (*ListParams) WithContext 

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

WithContext adds the context to the list params

func (*ListParams) WithDefaults 

func (o *ListParams) WithDefaults() *ListParams

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

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

func (*ListParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list params

func (*ListParams) WithLinkedResourceDescription 

func (o *ListParams) WithLinkedResourceDescription(linkedResourceDescription *string) *ListParams

WithLinkedResourceDescription adds the linkedResourceDescription to the list params

func (*ListParams) WithLinkedResourceID 

func (o *ListParams) WithLinkedResourceID(linkedResourceID *string) *ListParams

WithLinkedResourceID adds the linkedResourceID to the list params

func (*ListParams) WithLinkedResourceLocationRegionProvider 

func (o *ListParams) WithLinkedResourceLocationRegionProvider(linkedResourceLocationRegionProvider *string) *ListParams

WithLinkedResourceLocationRegionProvider adds the linkedResourceLocationRegionProvider to the list params

func (*ListParams) WithLinkedResourceLocationRegionRegion 

func (o *ListParams) WithLinkedResourceLocationRegionRegion(linkedResourceLocationRegionRegion *string) *ListParams

WithLinkedResourceLocationRegionRegion adds the linkedResourceLocationRegionRegion to the list params

func (*ListParams) WithLinkedResourceType 

func (o *ListParams) WithLinkedResourceType(linkedResourceType *string) *ListParams

WithLinkedResourceType adds the linkedResourceType to the list params

func (*ListParams) WithLinkedResourceUUID 

func (o *ListParams) WithLinkedResourceUUID(linkedResourceUUID *string) *ListParams

WithLinkedResourceUUID adds the linkedResourceUUID to the list params

func (*ListParams) WithLocationOrganizationID 

func (o *ListParams) WithLocationOrganizationID(locationOrganizationID string) *ListParams

WithLocationOrganizationID adds the locationOrganizationID to the list params

func (*ListParams) WithLocationProjectID 

func (o *ListParams) WithLocationProjectID(locationProjectID string) *ListParams

WithLocationProjectID adds the locationProjectID to the list params

func (*ListParams) WithLocationRegionProvider 

func (o *ListParams) WithLocationRegionProvider(locationRegionProvider *string) *ListParams

WithLocationRegionProvider adds the locationRegionProvider to the list params

func (*ListParams) WithLocationRegionRegion 

func (o *ListParams) WithLocationRegionRegion(locationRegionRegion *string) *ListParams

WithLocationRegionRegion adds the locationRegionRegion to the list params

func (*ListParams) WithPaginationNextPageToken 

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

WithPaginationNextPageToken adds the paginationNextPageToken to the list params

func (*ListParams) WithPaginationPageSize 

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

WithPaginationPageSize adds the paginationPageSize to the list params

func (*ListParams) WithPaginationPreviousPageToken 

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

WithPaginationPreviousPageToken adds the paginationPreviousPageToken to the list params

func (*ListParams) WithTimeout 

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

WithTimeout adds the timeout to the list params

func (*ListParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListReader 

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

ListReader is a Reader for the List structure.

func (*ListReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type WaitDefault 

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

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

An unexpected error response.

func NewWaitDefault 

func NewWaitDefault(code int) *WaitDefault

NewWaitDefault creates a WaitDefault with default headers values

func (*WaitDefault) Code 

func (o *WaitDefault) Code() int

Code gets the status code for the wait default response

func (*WaitDefault) Error 

func (o *WaitDefault) Error() string

func (*WaitDefault) GetPayload 

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

func (*WaitDefault) IsClientError 

func (o *WaitDefault) IsClientError() bool

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

func (*WaitDefault) IsCode 

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

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

func (*WaitDefault) IsRedirect 

func (o *WaitDefault) IsRedirect() bool

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

func (*WaitDefault) IsServerError 

func (o *WaitDefault) IsServerError() bool

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

func (*WaitDefault) IsSuccess 

func (o *WaitDefault) IsSuccess() bool

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

func (*WaitDefault) String 

func (o *WaitDefault) String() string

type WaitOK 

type WaitOK struct {
	Payload *models.HashicorpCloudOperationWaitResponse
}

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

A successful response.

func NewWaitOK 

func NewWaitOK() *WaitOK

NewWaitOK creates a WaitOK with default headers values

func (*WaitOK) Error 

func (o *WaitOK) Error() string

func (*WaitOK) GetPayload 

func (o *WaitOK) GetPayload() *models.HashicorpCloudOperationWaitResponse

func (*WaitOK) IsClientError 

func (o *WaitOK) IsClientError() bool

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

func (*WaitOK) IsCode 

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

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

func (*WaitOK) IsRedirect 

func (o *WaitOK) IsRedirect() bool

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

func (*WaitOK) IsServerError 

func (o *WaitOK) IsServerError() bool

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

func (*WaitOK) IsSuccess 

func (o *WaitOK) IsSuccess() bool

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

func (*WaitOK) String 

func (o *WaitOK) String() string

type WaitParams 

type WaitParams struct {

	/* ID.

	   id is the UUID of the operation.
	*/
	ID string

	/* LocationOrganizationID.

	   organization_id is the id of the organization.
	*/
	LocationOrganizationID string

	/* LocationProjectID.

	   project_id is the projects id.
	*/
	LocationProjectID string

	/* LocationRegionProvider.

	   provider is the named cloud provider ("aws", "gcp", "azure").
	*/
	LocationRegionProvider *string

	/* LocationRegionRegion.

	   region is the cloud region ("us-west1", "us-east1").
	*/
	LocationRegionRegion *string

	/* Timeout.

	     timeout is the duration to wait until timing out and returning.
	The shortest timeout is always used, so if the HTTP/RPC call has a
	shorter timeout then that will be used instead. When the timeout is
	reached, Wait will return with the operation no matter what state it is
	in.
	*/
	Timeout *string

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

WaitParams contains all the parameters to send to the API endpoint 

for the wait operation.

Typically these are written to a http.Request.

func NewWaitParams 

func NewWaitParams() *WaitParams

NewWaitParams creates a new WaitParams 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 NewWaitParamsWithContext 

func NewWaitParamsWithContext(ctx context.Context) *WaitParams

NewWaitParamsWithContext creates a new WaitParams object with the ability to set a context for a request.

func NewWaitParamsWithHTTPClient 

func NewWaitParamsWithHTTPClient(client *http.Client) *WaitParams

NewWaitParamsWithHTTPClient creates a new WaitParams object with the ability to set a custom HTTPClient for a request.

func NewWaitParamsWithTimeout 

func NewWaitParamsWithTimeout(timeout time.Duration) *WaitParams

NewWaitParamsWithTimeout creates a new WaitParams object with the ability to set a timeout on a request.

func (*WaitParams) SetContext 

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

SetContext adds the context to the wait params

func (*WaitParams) SetDefaults 

func (o *WaitParams) SetDefaults()

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

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

func (*WaitParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the wait params

func (*WaitParams) SetID 

func (o *WaitParams) SetID(id string)

SetID adds the id to the wait params

func (*WaitParams) SetLocationOrganizationID 

func (o *WaitParams) SetLocationOrganizationID(locationOrganizationID string)

SetLocationOrganizationID adds the locationOrganizationId to the wait params

func (*WaitParams) SetLocationProjectID 

func (o *WaitParams) SetLocationProjectID(locationProjectID string)

SetLocationProjectID adds the locationProjectId to the wait params

func (*WaitParams) SetLocationRegionProvider 

func (o *WaitParams) SetLocationRegionProvider(locationRegionProvider *string)

SetLocationRegionProvider adds the locationRegionProvider to the wait params

func (*WaitParams) SetLocationRegionRegion 

func (o *WaitParams) SetLocationRegionRegion(locationRegionRegion *string)

SetLocationRegionRegion adds the locationRegionRegion to the wait params

func (*WaitParams) SetRequestTimeout 

func (o *WaitParams) SetRequestTimeout(timeout time.Duration)

SetRequestTimeout adds the timeout to the wait params

func (*WaitParams) SetTimeout 

func (o *WaitParams) SetTimeout(timeout *string)

SetTimeout adds the timeout to the wait params

func (*WaitParams) WithContext 

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

WithContext adds the context to the wait params

func (*WaitParams) WithDefaults 

func (o *WaitParams) WithDefaults() *WaitParams

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

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

func (*WaitParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the wait params

func (*WaitParams) WithID 

func (o *WaitParams) WithID(id string) *WaitParams

WithID adds the id to the wait params

func (*WaitParams) WithLocationOrganizationID 

func (o *WaitParams) WithLocationOrganizationID(locationOrganizationID string) *WaitParams

WithLocationOrganizationID adds the locationOrganizationID to the wait params

func (*WaitParams) WithLocationProjectID 

func (o *WaitParams) WithLocationProjectID(locationProjectID string) *WaitParams

WithLocationProjectID adds the locationProjectID to the wait params

func (*WaitParams) WithLocationRegionProvider 

func (o *WaitParams) WithLocationRegionProvider(locationRegionProvider *string) *WaitParams

WithLocationRegionProvider adds the locationRegionProvider to the wait params

func (*WaitParams) WithLocationRegionRegion 

func (o *WaitParams) WithLocationRegionRegion(locationRegionRegion *string) *WaitParams

WithLocationRegionRegion adds the locationRegionRegion to the wait params

func (*WaitParams) WithRequestTimeout 

func (o *WaitParams) WithRequestTimeout(timeout time.Duration) *WaitParams

WithRequestTimeout adds the timeout to the wait params

func (*WaitParams) WithTimeout 

func (o *WaitParams) WithTimeout(timeout *string) *WaitParams

WithTimeout adds the timeout to the wait params

func (*WaitParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type WaitReader 

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

WaitReader is a Reader for the Wait structure.

func (*WaitReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.