families

package
v3.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2023 License: Apache-2.0 Imports: 11 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 families API

func (*Client) CreateFamily 

func (a *Client) CreateFamily(params *CreateFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*CreateFamilyCreated, error)

CreateFamily creates a new custom compliance family

Create a new custom compliance family.

func (*Client) DeleteFamily 

func (a *Client) DeleteFamily(params *DeleteFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteFamilyNoContent, error)

DeleteFamily deletes a family

Delete a Family.

func (*Client) GetFamily 

func (a *Client) GetFamily(params *GetFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*GetFamilyOK, error)

GetFamily looks up family

Return a specific Family.

func (*Client) ListFamilies 

func (a *Client) ListFamilies(params *ListFamiliesParams, authInfo runtime.ClientAuthInfoWriter) (*ListFamiliesOK, error)

ListFamilies lists compliance families

Return a list of compliance families.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) UpdateFamily 

func (a *Client) UpdateFamily(params *UpdateFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateFamilyOK, error)

UpdateFamily edits an existing user family

Edit an existing user Family.

type ClientService 

type ClientService interface {
	CreateFamily(params *CreateFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*CreateFamilyCreated, error)

	DeleteFamily(params *DeleteFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteFamilyNoContent, error)

	GetFamily(params *GetFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*GetFamilyOK, error)

	ListFamilies(params *ListFamiliesParams, authInfo runtime.ClientAuthInfoWriter) (*ListFamiliesOK, error)

	UpdateFamily(params *UpdateFamilyParams, authInfo runtime.ClientAuthInfoWriter) (*UpdateFamilyOK, 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 families API client.

type CreateFamilyBadRequest 

type CreateFamilyBadRequest struct {
	Payload *models.BadRequestError
}

CreateFamilyBadRequest handles this case with default header values.

BadRequestError

func NewCreateFamilyBadRequest 

func NewCreateFamilyBadRequest() *CreateFamilyBadRequest

NewCreateFamilyBadRequest creates a CreateFamilyBadRequest with default headers values

func (*CreateFamilyBadRequest) Error 

func (o *CreateFamilyBadRequest) Error() string

func (*CreateFamilyBadRequest) GetPayload 

func (o *CreateFamilyBadRequest) GetPayload() *models.BadRequestError

type CreateFamilyCreated 

type CreateFamilyCreated struct {
	Payload *models.FamilyWithRules
}

CreateFamilyCreated handles this case with default header values.

The newly-created custom compliance family.

func NewCreateFamilyCreated 

func NewCreateFamilyCreated() *CreateFamilyCreated

NewCreateFamilyCreated creates a CreateFamilyCreated with default headers values

func (*CreateFamilyCreated) Error 

func (o *CreateFamilyCreated) Error() string

func (*CreateFamilyCreated) GetPayload 

func (o *CreateFamilyCreated) GetPayload() *models.FamilyWithRules

type CreateFamilyForbidden 

type CreateFamilyForbidden struct {
	Payload *models.AuthorizationError
}

CreateFamilyForbidden handles this case with default header values.

AuthorizationError

func NewCreateFamilyForbidden 

func NewCreateFamilyForbidden() *CreateFamilyForbidden

NewCreateFamilyForbidden creates a CreateFamilyForbidden with default headers values

func (*CreateFamilyForbidden) Error 

func (o *CreateFamilyForbidden) Error() string

func (*CreateFamilyForbidden) GetPayload 

func (o *CreateFamilyForbidden) GetPayload() *models.AuthorizationError

type CreateFamilyInternalServerError 

type CreateFamilyInternalServerError struct {
	Payload *models.InternalServerError
}

CreateFamilyInternalServerError handles this case with default header values.

InternalServerError

func NewCreateFamilyInternalServerError 

func NewCreateFamilyInternalServerError() *CreateFamilyInternalServerError

NewCreateFamilyInternalServerError creates a CreateFamilyInternalServerError with default headers values

func (*CreateFamilyInternalServerError) Error 

func (o *CreateFamilyInternalServerError) Error() string

func (*CreateFamilyInternalServerError) GetPayload 

func (o *CreateFamilyInternalServerError) GetPayload() *models.InternalServerError

type CreateFamilyParams 

type CreateFamilyParams struct {

	/*Family
	  Configuration options for the new custom compliance family.

	*/
	Family *models.CreateFamilyInput

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

CreateFamilyParams contains all the parameters to send to the API endpoint for the create family operation typically these are written to a http.Request

func NewCreateFamilyParams 

func NewCreateFamilyParams() *CreateFamilyParams

NewCreateFamilyParams creates a new CreateFamilyParams object with the default values initialized.

func NewCreateFamilyParamsWithContext 

func NewCreateFamilyParamsWithContext(ctx context.Context) *CreateFamilyParams

NewCreateFamilyParamsWithContext creates a new CreateFamilyParams object with the default values initialized, and the ability to set a context for a request

func NewCreateFamilyParamsWithHTTPClient 

func NewCreateFamilyParamsWithHTTPClient(client *http.Client) *CreateFamilyParams

NewCreateFamilyParamsWithHTTPClient creates a new CreateFamilyParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewCreateFamilyParamsWithTimeout 

func NewCreateFamilyParamsWithTimeout(timeout time.Duration) *CreateFamilyParams

NewCreateFamilyParamsWithTimeout creates a new CreateFamilyParams object with the default values initialized, and the ability to set a timeout on a request

func (*CreateFamilyParams) SetContext 

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

SetContext adds the context to the create family params

func (*CreateFamilyParams) SetFamily 

func (o *CreateFamilyParams) SetFamily(family *models.CreateFamilyInput)

SetFamily adds the family to the create family params

func (*CreateFamilyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the create family params

func (*CreateFamilyParams) SetTimeout 

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

SetTimeout adds the timeout to the create family params

func (*CreateFamilyParams) WithContext 

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

WithContext adds the context to the create family params

func (*CreateFamilyParams) WithFamily 

func (o *CreateFamilyParams) WithFamily(family *models.CreateFamilyInput) *CreateFamilyParams

WithFamily adds the family to the create family params

func (*CreateFamilyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the create family params

func (*CreateFamilyParams) WithTimeout 

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

WithTimeout adds the timeout to the create family params

func (*CreateFamilyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CreateFamilyReader 

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

CreateFamilyReader is a Reader for the CreateFamily structure.

func (*CreateFamilyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type CreateFamilyUnauthorized 

type CreateFamilyUnauthorized struct {
	Payload *models.AuthenticationError
}

CreateFamilyUnauthorized handles this case with default header values.

AuthenticationError

func NewCreateFamilyUnauthorized 

func NewCreateFamilyUnauthorized() *CreateFamilyUnauthorized

NewCreateFamilyUnauthorized creates a CreateFamilyUnauthorized with default headers values

func (*CreateFamilyUnauthorized) Error 

func (o *CreateFamilyUnauthorized) Error() string

func (*CreateFamilyUnauthorized) GetPayload 

func (o *CreateFamilyUnauthorized) GetPayload() *models.AuthenticationError

type DeleteFamilyBadRequest 

type DeleteFamilyBadRequest struct {
	Payload *models.BadRequestError
}

DeleteFamilyBadRequest handles this case with default header values.

BadRequestError

func NewDeleteFamilyBadRequest 

func NewDeleteFamilyBadRequest() *DeleteFamilyBadRequest

NewDeleteFamilyBadRequest creates a DeleteFamilyBadRequest with default headers values

func (*DeleteFamilyBadRequest) Error 

func (o *DeleteFamilyBadRequest) Error() string

func (*DeleteFamilyBadRequest) GetPayload 

func (o *DeleteFamilyBadRequest) GetPayload() *models.BadRequestError

type DeleteFamilyForbidden 

type DeleteFamilyForbidden struct {
	Payload *models.AuthorizationError
}

DeleteFamilyForbidden handles this case with default header values.

AuthorizationError

func NewDeleteFamilyForbidden 

func NewDeleteFamilyForbidden() *DeleteFamilyForbidden

NewDeleteFamilyForbidden creates a DeleteFamilyForbidden with default headers values

func (*DeleteFamilyForbidden) Error 

func (o *DeleteFamilyForbidden) Error() string

func (*DeleteFamilyForbidden) GetPayload 

func (o *DeleteFamilyForbidden) GetPayload() *models.AuthorizationError

type DeleteFamilyInternalServerError 

type DeleteFamilyInternalServerError struct {
	Payload *models.InternalServerError
}

DeleteFamilyInternalServerError handles this case with default header values.

InternalServerError

func NewDeleteFamilyInternalServerError 

func NewDeleteFamilyInternalServerError() *DeleteFamilyInternalServerError

NewDeleteFamilyInternalServerError creates a DeleteFamilyInternalServerError with default headers values

func (*DeleteFamilyInternalServerError) Error 

func (o *DeleteFamilyInternalServerError) Error() string

func (*DeleteFamilyInternalServerError) GetPayload 

func (o *DeleteFamilyInternalServerError) GetPayload() *models.InternalServerError

type DeleteFamilyNoContent 

type DeleteFamilyNoContent struct {
}

DeleteFamilyNoContent handles this case with default header values.

Family deleted.

func NewDeleteFamilyNoContent 

func NewDeleteFamilyNoContent() *DeleteFamilyNoContent

NewDeleteFamilyNoContent creates a DeleteFamilyNoContent with default headers values

func (*DeleteFamilyNoContent) Error 

func (o *DeleteFamilyNoContent) Error() string

type DeleteFamilyParams 

type DeleteFamilyParams struct {

	/*FamilyID
	  The id of the Family to delete.

	*/
	FamilyID string

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

DeleteFamilyParams contains all the parameters to send to the API endpoint for the delete family operation typically these are written to a http.Request

func NewDeleteFamilyParams 

func NewDeleteFamilyParams() *DeleteFamilyParams

NewDeleteFamilyParams creates a new DeleteFamilyParams object with the default values initialized.

func NewDeleteFamilyParamsWithContext 

func NewDeleteFamilyParamsWithContext(ctx context.Context) *DeleteFamilyParams

NewDeleteFamilyParamsWithContext creates a new DeleteFamilyParams object with the default values initialized, and the ability to set a context for a request

func NewDeleteFamilyParamsWithHTTPClient 

func NewDeleteFamilyParamsWithHTTPClient(client *http.Client) *DeleteFamilyParams

NewDeleteFamilyParamsWithHTTPClient creates a new DeleteFamilyParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewDeleteFamilyParamsWithTimeout 

func NewDeleteFamilyParamsWithTimeout(timeout time.Duration) *DeleteFamilyParams

NewDeleteFamilyParamsWithTimeout creates a new DeleteFamilyParams object with the default values initialized, and the ability to set a timeout on a request

func (*DeleteFamilyParams) SetContext 

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

SetContext adds the context to the delete family params

func (*DeleteFamilyParams) SetFamilyID 

func (o *DeleteFamilyParams) SetFamilyID(familyID string)

SetFamilyID adds the familyId to the delete family params

func (*DeleteFamilyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the delete family params

func (*DeleteFamilyParams) SetTimeout 

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

SetTimeout adds the timeout to the delete family params

func (*DeleteFamilyParams) WithContext 

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

WithContext adds the context to the delete family params

func (*DeleteFamilyParams) WithFamilyID 

func (o *DeleteFamilyParams) WithFamilyID(familyID string) *DeleteFamilyParams

WithFamilyID adds the familyID to the delete family params

func (*DeleteFamilyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the delete family params

func (*DeleteFamilyParams) WithTimeout 

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

WithTimeout adds the timeout to the delete family params

func (*DeleteFamilyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DeleteFamilyReader 

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

DeleteFamilyReader is a Reader for the DeleteFamily structure.

func (*DeleteFamilyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DeleteFamilyUnauthorized 

type DeleteFamilyUnauthorized struct {
	Payload *models.AuthenticationError
}

DeleteFamilyUnauthorized handles this case with default header values.

AuthenticationError

func NewDeleteFamilyUnauthorized 

func NewDeleteFamilyUnauthorized() *DeleteFamilyUnauthorized

NewDeleteFamilyUnauthorized creates a DeleteFamilyUnauthorized with default headers values

func (*DeleteFamilyUnauthorized) Error 

func (o *DeleteFamilyUnauthorized) Error() string

func (*DeleteFamilyUnauthorized) GetPayload 

func (o *DeleteFamilyUnauthorized) GetPayload() *models.AuthenticationError

type GetFamilyBadRequest 

type GetFamilyBadRequest struct {
	Payload *models.BadRequestError
}

GetFamilyBadRequest handles this case with default header values.

BadRequestError

func NewGetFamilyBadRequest 

func NewGetFamilyBadRequest() *GetFamilyBadRequest

NewGetFamilyBadRequest creates a GetFamilyBadRequest with default headers values

func (*GetFamilyBadRequest) Error 

func (o *GetFamilyBadRequest) Error() string

func (*GetFamilyBadRequest) GetPayload 

func (o *GetFamilyBadRequest) GetPayload() *models.BadRequestError

type GetFamilyForbidden 

type GetFamilyForbidden struct {
	Payload *models.AuthorizationError
}

GetFamilyForbidden handles this case with default header values.

AuthorizationError

func NewGetFamilyForbidden 

func NewGetFamilyForbidden() *GetFamilyForbidden

NewGetFamilyForbidden creates a GetFamilyForbidden with default headers values

func (*GetFamilyForbidden) Error 

func (o *GetFamilyForbidden) Error() string

func (*GetFamilyForbidden) GetPayload 

func (o *GetFamilyForbidden) GetPayload() *models.AuthorizationError

type GetFamilyInternalServerError 

type GetFamilyInternalServerError struct {
	Payload *models.InternalServerError
}

GetFamilyInternalServerError handles this case with default header values.

InternalServerError

func NewGetFamilyInternalServerError 

func NewGetFamilyInternalServerError() *GetFamilyInternalServerError

NewGetFamilyInternalServerError creates a GetFamilyInternalServerError with default headers values

func (*GetFamilyInternalServerError) Error 

func (o *GetFamilyInternalServerError) Error() string

func (*GetFamilyInternalServerError) GetPayload 

func (o *GetFamilyInternalServerError) GetPayload() *models.InternalServerError

type GetFamilyNotFound 

type GetFamilyNotFound struct {
	Payload *models.NotFoundError
}

GetFamilyNotFound handles this case with default header values.

NotFoundError

func NewGetFamilyNotFound 

func NewGetFamilyNotFound() *GetFamilyNotFound

NewGetFamilyNotFound creates a GetFamilyNotFound with default headers values

func (*GetFamilyNotFound) Error 

func (o *GetFamilyNotFound) Error() string

func (*GetFamilyNotFound) GetPayload 

func (o *GetFamilyNotFound) GetPayload() *models.NotFoundError

type GetFamilyOK 

type GetFamilyOK struct {
	Payload *models.FamilyWithRules
}

GetFamilyOK handles this case with default header values.

The desired Family.

func NewGetFamilyOK 

func NewGetFamilyOK() *GetFamilyOK

NewGetFamilyOK creates a GetFamilyOK with default headers values

func (*GetFamilyOK) Error 

func (o *GetFamilyOK) Error() string

func (*GetFamilyOK) GetPayload 

func (o *GetFamilyOK) GetPayload() *models.FamilyWithRules

type GetFamilyParams 

type GetFamilyParams struct {

	/*FamilyID
	  The id of the Family to look up.

	*/
	FamilyID string

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

GetFamilyParams contains all the parameters to send to the API endpoint for the get family operation typically these are written to a http.Request

func NewGetFamilyParams 

func NewGetFamilyParams() *GetFamilyParams

NewGetFamilyParams creates a new GetFamilyParams object with the default values initialized.

func NewGetFamilyParamsWithContext 

func NewGetFamilyParamsWithContext(ctx context.Context) *GetFamilyParams

NewGetFamilyParamsWithContext creates a new GetFamilyParams object with the default values initialized, and the ability to set a context for a request

func NewGetFamilyParamsWithHTTPClient 

func NewGetFamilyParamsWithHTTPClient(client *http.Client) *GetFamilyParams

NewGetFamilyParamsWithHTTPClient creates a new GetFamilyParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetFamilyParamsWithTimeout 

func NewGetFamilyParamsWithTimeout(timeout time.Duration) *GetFamilyParams

NewGetFamilyParamsWithTimeout creates a new GetFamilyParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetFamilyParams) SetContext 

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

SetContext adds the context to the get family params

func (*GetFamilyParams) SetFamilyID 

func (o *GetFamilyParams) SetFamilyID(familyID string)

SetFamilyID adds the familyId to the get family params

func (*GetFamilyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get family params

func (*GetFamilyParams) SetTimeout 

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

SetTimeout adds the timeout to the get family params

func (*GetFamilyParams) WithContext 

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

WithContext adds the context to the get family params

func (*GetFamilyParams) WithFamilyID 

func (o *GetFamilyParams) WithFamilyID(familyID string) *GetFamilyParams

WithFamilyID adds the familyID to the get family params

func (*GetFamilyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get family params

func (*GetFamilyParams) WithTimeout 

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

WithTimeout adds the timeout to the get family params

func (*GetFamilyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetFamilyReader 

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

GetFamilyReader is a Reader for the GetFamily structure.

func (*GetFamilyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetFamilyUnauthorized 

type GetFamilyUnauthorized struct {
	Payload *models.AuthenticationError
}

GetFamilyUnauthorized handles this case with default header values.

AuthenticationError

func NewGetFamilyUnauthorized 

func NewGetFamilyUnauthorized() *GetFamilyUnauthorized

NewGetFamilyUnauthorized creates a GetFamilyUnauthorized with default headers values

func (*GetFamilyUnauthorized) Error 

func (o *GetFamilyUnauthorized) Error() string

func (*GetFamilyUnauthorized) GetPayload 

func (o *GetFamilyUnauthorized) GetPayload() *models.AuthenticationError

type ListFamiliesBadRequest 

type ListFamiliesBadRequest struct {
	Payload *models.BadRequestError
}

ListFamiliesBadRequest handles this case with default header values.

BadRequestError

func NewListFamiliesBadRequest 

func NewListFamiliesBadRequest() *ListFamiliesBadRequest

NewListFamiliesBadRequest creates a ListFamiliesBadRequest with default headers values

func (*ListFamiliesBadRequest) Error 

func (o *ListFamiliesBadRequest) Error() string

func (*ListFamiliesBadRequest) GetPayload 

func (o *ListFamiliesBadRequest) GetPayload() *models.BadRequestError

type ListFamiliesForbidden 

type ListFamiliesForbidden struct {
	Payload *models.AuthorizationError
}

ListFamiliesForbidden handles this case with default header values.

AuthorizationError

func NewListFamiliesForbidden 

func NewListFamiliesForbidden() *ListFamiliesForbidden

NewListFamiliesForbidden creates a ListFamiliesForbidden with default headers values

func (*ListFamiliesForbidden) Error 

func (o *ListFamiliesForbidden) Error() string

func (*ListFamiliesForbidden) GetPayload 

func (o *ListFamiliesForbidden) GetPayload() *models.AuthorizationError

type ListFamiliesInternalServerError 

type ListFamiliesInternalServerError struct {
	Payload *models.InternalServerError
}

ListFamiliesInternalServerError handles this case with default header values.

InternalServerError

func NewListFamiliesInternalServerError 

func NewListFamiliesInternalServerError() *ListFamiliesInternalServerError

NewListFamiliesInternalServerError creates a ListFamiliesInternalServerError with default headers values

func (*ListFamiliesInternalServerError) Error 

func (o *ListFamiliesInternalServerError) Error() string

func (*ListFamiliesInternalServerError) GetPayload 

func (o *ListFamiliesInternalServerError) GetPayload() *models.InternalServerError

type ListFamiliesOK 

type ListFamiliesOK struct {
	Payload *models.Families
}

ListFamiliesOK handles this case with default header values.

List of compliance families.

func NewListFamiliesOK 

func NewListFamiliesOK() *ListFamiliesOK

NewListFamiliesOK creates a ListFamiliesOK with default headers values

func (*ListFamiliesOK) Error 

func (o *ListFamiliesOK) Error() string

func (*ListFamiliesOK) GetPayload 

func (o *ListFamiliesOK) GetPayload() *models.Families

type ListFamiliesParams 

type ListFamiliesParams struct {

	/*MaxItems
	  Maximum number of items to return.

	*/
	MaxItems *int64
	/*Offset
	  Number of items to skip before returning. This parameter is used when the number of items spans multiple pages.

	*/
	Offset *int64
	/*OrderBy
	  Attribute to order families by

	*/
	OrderBy *string
	/*OrderDirection
	  Order families in an ascending or descending fashion

	*/
	OrderDirection *string
	/*Query
	  A stringified JSON array of search parameters.

	*/
	Query *string

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

ListFamiliesParams contains all the parameters to send to the API endpoint for the list families operation typically these are written to a http.Request

func NewListFamiliesParams 

func NewListFamiliesParams() *ListFamiliesParams

NewListFamiliesParams creates a new ListFamiliesParams object with the default values initialized.

func NewListFamiliesParamsWithContext 

func NewListFamiliesParamsWithContext(ctx context.Context) *ListFamiliesParams

NewListFamiliesParamsWithContext creates a new ListFamiliesParams object with the default values initialized, and the ability to set a context for a request

func NewListFamiliesParamsWithHTTPClient 

func NewListFamiliesParamsWithHTTPClient(client *http.Client) *ListFamiliesParams

NewListFamiliesParamsWithHTTPClient creates a new ListFamiliesParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListFamiliesParamsWithTimeout 

func NewListFamiliesParamsWithTimeout(timeout time.Duration) *ListFamiliesParams

NewListFamiliesParamsWithTimeout creates a new ListFamiliesParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListFamiliesParams) SetContext 

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

SetContext adds the context to the list families params

func (*ListFamiliesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list families params

func (*ListFamiliesParams) SetMaxItems 

func (o *ListFamiliesParams) SetMaxItems(maxItems *int64)

SetMaxItems adds the maxItems to the list families params

func (*ListFamiliesParams) SetOffset 

func (o *ListFamiliesParams) SetOffset(offset *int64)

SetOffset adds the offset to the list families params

func (*ListFamiliesParams) SetOrderBy 

func (o *ListFamiliesParams) SetOrderBy(orderBy *string)

SetOrderBy adds the orderBy to the list families params

func (*ListFamiliesParams) SetOrderDirection 

func (o *ListFamiliesParams) SetOrderDirection(orderDirection *string)

SetOrderDirection adds the orderDirection to the list families params

func (*ListFamiliesParams) SetQuery 

func (o *ListFamiliesParams) SetQuery(query *string)

SetQuery adds the query to the list families params

func (*ListFamiliesParams) SetTimeout 

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

SetTimeout adds the timeout to the list families params

func (*ListFamiliesParams) WithContext 

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

WithContext adds the context to the list families params

func (*ListFamiliesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list families params

func (*ListFamiliesParams) WithMaxItems 

func (o *ListFamiliesParams) WithMaxItems(maxItems *int64) *ListFamiliesParams

WithMaxItems adds the maxItems to the list families params

func (*ListFamiliesParams) WithOffset 

func (o *ListFamiliesParams) WithOffset(offset *int64) *ListFamiliesParams

WithOffset adds the offset to the list families params

func (*ListFamiliesParams) WithOrderBy 

func (o *ListFamiliesParams) WithOrderBy(orderBy *string) *ListFamiliesParams

WithOrderBy adds the orderBy to the list families params

func (*ListFamiliesParams) WithOrderDirection 

func (o *ListFamiliesParams) WithOrderDirection(orderDirection *string) *ListFamiliesParams

WithOrderDirection adds the orderDirection to the list families params

func (*ListFamiliesParams) WithQuery 

func (o *ListFamiliesParams) WithQuery(query *string) *ListFamiliesParams

WithQuery adds the query to the list families params

func (*ListFamiliesParams) WithTimeout 

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

WithTimeout adds the timeout to the list families params

func (*ListFamiliesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListFamiliesReader 

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

ListFamiliesReader is a Reader for the ListFamilies structure.

func (*ListFamiliesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListFamiliesUnauthorized 

type ListFamiliesUnauthorized struct {
	Payload *models.AuthenticationError
}

ListFamiliesUnauthorized handles this case with default header values.

AuthenticationError

func NewListFamiliesUnauthorized 

func NewListFamiliesUnauthorized() *ListFamiliesUnauthorized

NewListFamiliesUnauthorized creates a ListFamiliesUnauthorized with default headers values

func (*ListFamiliesUnauthorized) Error 

func (o *ListFamiliesUnauthorized) Error() string

func (*ListFamiliesUnauthorized) GetPayload 

func (o *ListFamiliesUnauthorized) GetPayload() *models.AuthenticationError

type UpdateFamilyBadRequest 

type UpdateFamilyBadRequest struct {
	Payload *models.BadRequestError
}

UpdateFamilyBadRequest handles this case with default header values.

BadRequestError

func NewUpdateFamilyBadRequest 

func NewUpdateFamilyBadRequest() *UpdateFamilyBadRequest

NewUpdateFamilyBadRequest creates a UpdateFamilyBadRequest with default headers values

func (*UpdateFamilyBadRequest) Error 

func (o *UpdateFamilyBadRequest) Error() string

func (*UpdateFamilyBadRequest) GetPayload 

func (o *UpdateFamilyBadRequest) GetPayload() *models.BadRequestError

type UpdateFamilyForbidden 

type UpdateFamilyForbidden struct {
	Payload *models.AuthorizationError
}

UpdateFamilyForbidden handles this case with default header values.

AuthorizationError

func NewUpdateFamilyForbidden 

func NewUpdateFamilyForbidden() *UpdateFamilyForbidden

NewUpdateFamilyForbidden creates a UpdateFamilyForbidden with default headers values

func (*UpdateFamilyForbidden) Error 

func (o *UpdateFamilyForbidden) Error() string

func (*UpdateFamilyForbidden) GetPayload 

func (o *UpdateFamilyForbidden) GetPayload() *models.AuthorizationError

type UpdateFamilyInternalServerError 

type UpdateFamilyInternalServerError struct {
	Payload *models.InternalServerError
}

UpdateFamilyInternalServerError handles this case with default header values.

InternalServerError

func NewUpdateFamilyInternalServerError 

func NewUpdateFamilyInternalServerError() *UpdateFamilyInternalServerError

NewUpdateFamilyInternalServerError creates a UpdateFamilyInternalServerError with default headers values

func (*UpdateFamilyInternalServerError) Error 

func (o *UpdateFamilyInternalServerError) Error() string

func (*UpdateFamilyInternalServerError) GetPayload 

func (o *UpdateFamilyInternalServerError) GetPayload() *models.InternalServerError

type UpdateFamilyNotFound 

type UpdateFamilyNotFound struct {
	Payload *models.NotFoundError
}

UpdateFamilyNotFound handles this case with default header values.

NotFoundError

func NewUpdateFamilyNotFound 

func NewUpdateFamilyNotFound() *UpdateFamilyNotFound

NewUpdateFamilyNotFound creates a UpdateFamilyNotFound with default headers values

func (*UpdateFamilyNotFound) Error 

func (o *UpdateFamilyNotFound) Error() string

func (*UpdateFamilyNotFound) GetPayload 

func (o *UpdateFamilyNotFound) GetPayload() *models.NotFoundError

type UpdateFamilyOK 

type UpdateFamilyOK struct {
	Payload *models.FamilyWithRules
}

UpdateFamilyOK handles this case with default header values.

The updated Family.

func NewUpdateFamilyOK 

func NewUpdateFamilyOK() *UpdateFamilyOK

NewUpdateFamilyOK creates a UpdateFamilyOK with default headers values

func (*UpdateFamilyOK) Error 

func (o *UpdateFamilyOK) Error() string

func (*UpdateFamilyOK) GetPayload 

func (o *UpdateFamilyOK) GetPayload() *models.FamilyWithRules

type UpdateFamilyParams 

type UpdateFamilyParams struct {

	/*Family
	  New configuration options for the Family.

	*/
	Family *models.UpdateFamilyInput
	/*FamilyID
	  The id of the Family to update.

	*/
	FamilyID string

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

UpdateFamilyParams contains all the parameters to send to the API endpoint for the update family operation typically these are written to a http.Request

func NewUpdateFamilyParams 

func NewUpdateFamilyParams() *UpdateFamilyParams

NewUpdateFamilyParams creates a new UpdateFamilyParams object with the default values initialized.

func NewUpdateFamilyParamsWithContext 

func NewUpdateFamilyParamsWithContext(ctx context.Context) *UpdateFamilyParams

NewUpdateFamilyParamsWithContext creates a new UpdateFamilyParams object with the default values initialized, and the ability to set a context for a request

func NewUpdateFamilyParamsWithHTTPClient 

func NewUpdateFamilyParamsWithHTTPClient(client *http.Client) *UpdateFamilyParams

NewUpdateFamilyParamsWithHTTPClient creates a new UpdateFamilyParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewUpdateFamilyParamsWithTimeout 

func NewUpdateFamilyParamsWithTimeout(timeout time.Duration) *UpdateFamilyParams

NewUpdateFamilyParamsWithTimeout creates a new UpdateFamilyParams object with the default values initialized, and the ability to set a timeout on a request

func (*UpdateFamilyParams) SetContext 

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

SetContext adds the context to the update family params

func (*UpdateFamilyParams) SetFamily 

func (o *UpdateFamilyParams) SetFamily(family *models.UpdateFamilyInput)

SetFamily adds the family to the update family params

func (*UpdateFamilyParams) SetFamilyID 

func (o *UpdateFamilyParams) SetFamilyID(familyID string)

SetFamilyID adds the familyId to the update family params

func (*UpdateFamilyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the update family params

func (*UpdateFamilyParams) SetTimeout 

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

SetTimeout adds the timeout to the update family params

func (*UpdateFamilyParams) WithContext 

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

WithContext adds the context to the update family params

func (*UpdateFamilyParams) WithFamily 

func (o *UpdateFamilyParams) WithFamily(family *models.UpdateFamilyInput) *UpdateFamilyParams

WithFamily adds the family to the update family params

func (*UpdateFamilyParams) WithFamilyID 

func (o *UpdateFamilyParams) WithFamilyID(familyID string) *UpdateFamilyParams

WithFamilyID adds the familyID to the update family params

func (*UpdateFamilyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the update family params

func (*UpdateFamilyParams) WithTimeout 

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

WithTimeout adds the timeout to the update family params

func (*UpdateFamilyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UpdateFamilyReader 

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

UpdateFamilyReader is a Reader for the UpdateFamily structure.

func (*UpdateFamilyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type UpdateFamilyUnauthorized 

type UpdateFamilyUnauthorized struct {
	Payload *models.AuthenticationError
}

UpdateFamilyUnauthorized handles this case with default header values.

AuthenticationError

func NewUpdateFamilyUnauthorized 

func NewUpdateFamilyUnauthorized() *UpdateFamilyUnauthorized

NewUpdateFamilyUnauthorized creates a UpdateFamilyUnauthorized with default headers values

func (*UpdateFamilyUnauthorized) Error 

func (o *UpdateFamilyUnauthorized) Error() string

func (*UpdateFamilyUnauthorized) GetPayload 

func (o *UpdateFamilyUnauthorized) GetPayload() *models.AuthenticationError

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.