workspaces

package
v0.0.0-...-9ad40bb Latest Latest
Warning

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

 Go to latest Published: Nov 16, 2025 License: Apache-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 workspaces API

func (*Client) ListWorkspaces 

func (a *Client) ListWorkspaces(params *ListWorkspacesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListWorkspacesOK, error)

ListWorkspaces lists workspaces

List workspaces

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {
	ListWorkspaces(params *ListWorkspacesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListWorkspacesOK, 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 workspaces API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new workspaces API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new workspaces API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type ListWorkspacesForbidden 

type ListWorkspacesForbidden struct {
	Payload *models.Error
}

ListWorkspacesForbidden describes a response with status code 403, with default header values.

Forbidden

func NewListWorkspacesForbidden 

func NewListWorkspacesForbidden() *ListWorkspacesForbidden

NewListWorkspacesForbidden creates a ListWorkspacesForbidden with default headers values

func (*ListWorkspacesForbidden) Code 

func (o *ListWorkspacesForbidden) Code() int

Code gets the status code for the list workspaces forbidden response

func (*ListWorkspacesForbidden) Error 

func (o *ListWorkspacesForbidden) Error() string

func (*ListWorkspacesForbidden) GetPayload 

func (o *ListWorkspacesForbidden) GetPayload() *models.Error

func (*ListWorkspacesForbidden) IsClientError 

func (o *ListWorkspacesForbidden) IsClientError() bool

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

func (*ListWorkspacesForbidden) IsCode 

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

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

func (*ListWorkspacesForbidden) IsRedirect 

func (o *ListWorkspacesForbidden) IsRedirect() bool

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

func (*ListWorkspacesForbidden) IsServerError 

func (o *ListWorkspacesForbidden) IsServerError() bool

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

func (*ListWorkspacesForbidden) IsSuccess 

func (o *ListWorkspacesForbidden) IsSuccess() bool

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

func (*ListWorkspacesForbidden) String 

func (o *ListWorkspacesForbidden) String() string

type ListWorkspacesNotFound 

type ListWorkspacesNotFound struct {
	Payload *models.Error
}

ListWorkspacesNotFound describes a response with status code 404, with default header values.

Not found

func NewListWorkspacesNotFound 

func NewListWorkspacesNotFound() *ListWorkspacesNotFound

NewListWorkspacesNotFound creates a ListWorkspacesNotFound with default headers values

func (*ListWorkspacesNotFound) Code 

func (o *ListWorkspacesNotFound) Code() int

Code gets the status code for the list workspaces not found response

func (*ListWorkspacesNotFound) Error 

func (o *ListWorkspacesNotFound) Error() string

func (*ListWorkspacesNotFound) GetPayload 

func (o *ListWorkspacesNotFound) GetPayload() *models.Error

func (*ListWorkspacesNotFound) IsClientError 

func (o *ListWorkspacesNotFound) IsClientError() bool

IsClientError returns true when this list workspaces not found response has a 4xx status code

func (*ListWorkspacesNotFound) IsCode 

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

IsCode returns true when this list workspaces not found response a status code equal to that given

func (*ListWorkspacesNotFound) IsRedirect 

func (o *ListWorkspacesNotFound) IsRedirect() bool

IsRedirect returns true when this list workspaces not found response has a 3xx status code

func (*ListWorkspacesNotFound) IsServerError 

func (o *ListWorkspacesNotFound) IsServerError() bool

IsServerError returns true when this list workspaces not found response has a 5xx status code

func (*ListWorkspacesNotFound) IsSuccess 

func (o *ListWorkspacesNotFound) IsSuccess() bool

IsSuccess returns true when this list workspaces not found response has a 2xx status code

func (*ListWorkspacesNotFound) String 

func (o *ListWorkspacesNotFound) String() string

type ListWorkspacesOK 

type ListWorkspacesOK struct {

	/* The ETag HTTP header is an identifier for a specific version of a resource

	in:header

	     Format: etag
	*/
	Etag string

	Payload *models.WorkspacesResponse
}

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

Workspaces

func NewListWorkspacesOK 

func NewListWorkspacesOK() *ListWorkspacesOK

NewListWorkspacesOK creates a ListWorkspacesOK with default headers values

func (*ListWorkspacesOK) Code 

func (o *ListWorkspacesOK) Code() int

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

func (*ListWorkspacesOK) Error 

func (o *ListWorkspacesOK) Error() string

func (*ListWorkspacesOK) GetPayload 

func (o *ListWorkspacesOK) GetPayload() *models.WorkspacesResponse

func (*ListWorkspacesOK) IsClientError 

func (o *ListWorkspacesOK) IsClientError() bool

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

func (*ListWorkspacesOK) IsCode 

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

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

func (*ListWorkspacesOK) IsRedirect 

func (o *ListWorkspacesOK) IsRedirect() bool

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

func (*ListWorkspacesOK) IsServerError 

func (o *ListWorkspacesOK) IsServerError() bool

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

func (*ListWorkspacesOK) IsSuccess 

func (o *ListWorkspacesOK) IsSuccess() bool

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

func (*ListWorkspacesOK) String 

func (o *ListWorkspacesOK) String() string

type ListWorkspacesParams 

type ListWorkspacesParams struct {

	/* AfterWorkspaceID.

	     optional list workspaces after given id
	AfterWorkspaceID
	*/
	AfterWorkspaceID *string

	/* BeforeWorkspaceID.

	     optional list workspaces before given id
	BeforeWorkspaceID
	*/
	BeforeWorkspaceID *string

	/* IfMatch.

	   A server will only return requested resources if the resource matches one of the listed ETag value

	   Format: etag
	*/
	IfMatch *string

	/* Limit.

	     optional limit results
	Limit

	     Format: int64
	     Default: 20
	*/
	Limit *int64

	/* Order.

	     optional order workspaces by given direction
	Order
	*/
	Order *string

	/* SearchPhrase.

	     Optional search phrase: workspace id OR workspace name substring (case insensitive)
	SearchPhrase
	*/
	SearchPhrase *string

	/* Sort.

	     optional sort workspaces by given field
	Sort
	*/
	Sort *string

	/* Template.

	   optional flag to filter by template
	*/
	Template *bool

	/* TenantID.

	   Tenant ID

	   Default: "default"
	*/
	TenantID string

	/* ThemeID.

	   optional flag to filter by theme id
	*/
	ThemeID *string

	/* WorkspaceTypes.

	   comma separated workspace types that are to be filtered out

	   Default: "admin,developer,system,regular,organization"
	*/
	WorkspaceTypes *string

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

ListWorkspacesParams contains all the parameters to send to the API endpoint 

for the list workspaces operation.

Typically these are written to a http.Request.

func NewListWorkspacesParams 

func NewListWorkspacesParams() *ListWorkspacesParams

NewListWorkspacesParams creates a new ListWorkspacesParams 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 NewListWorkspacesParamsWithContext 

func NewListWorkspacesParamsWithContext(ctx context.Context) *ListWorkspacesParams

NewListWorkspacesParamsWithContext creates a new ListWorkspacesParams object with the ability to set a context for a request.

func NewListWorkspacesParamsWithHTTPClient 

func NewListWorkspacesParamsWithHTTPClient(client *http.Client) *ListWorkspacesParams

NewListWorkspacesParamsWithHTTPClient creates a new ListWorkspacesParams object with the ability to set a custom HTTPClient for a request.

func NewListWorkspacesParamsWithTimeout 

func NewListWorkspacesParamsWithTimeout(timeout time.Duration) *ListWorkspacesParams

NewListWorkspacesParamsWithTimeout creates a new ListWorkspacesParams object with the ability to set a timeout on a request.

func (*ListWorkspacesParams) SetAfterWorkspaceID 

func (o *ListWorkspacesParams) SetAfterWorkspaceID(afterWorkspaceID *string)

SetAfterWorkspaceID adds the afterWorkspaceId to the list workspaces params

func (*ListWorkspacesParams) SetBeforeWorkspaceID 

func (o *ListWorkspacesParams) SetBeforeWorkspaceID(beforeWorkspaceID *string)

SetBeforeWorkspaceID adds the beforeWorkspaceId to the list workspaces params

func (*ListWorkspacesParams) SetContext 

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

SetContext adds the context to the list workspaces params

func (*ListWorkspacesParams) SetDefaults 

func (o *ListWorkspacesParams) SetDefaults()

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

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

func (*ListWorkspacesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list workspaces params

func (*ListWorkspacesParams) SetIfMatch 

func (o *ListWorkspacesParams) SetIfMatch(ifMatch *string)

SetIfMatch adds the ifMatch to the list workspaces params

func (*ListWorkspacesParams) SetLimit 

func (o *ListWorkspacesParams) SetLimit(limit *int64)

SetLimit adds the limit to the list workspaces params

func (*ListWorkspacesParams) SetOrder 

func (o *ListWorkspacesParams) SetOrder(order *string)

SetOrder adds the order to the list workspaces params

func (*ListWorkspacesParams) SetSearchPhrase 

func (o *ListWorkspacesParams) SetSearchPhrase(searchPhrase *string)

SetSearchPhrase adds the searchPhrase to the list workspaces params

func (*ListWorkspacesParams) SetSort 

func (o *ListWorkspacesParams) SetSort(sort *string)

SetSort adds the sort to the list workspaces params

func (*ListWorkspacesParams) SetTemplate 

func (o *ListWorkspacesParams) SetTemplate(template *bool)

SetTemplate adds the template to the list workspaces params

func (*ListWorkspacesParams) SetTenantID 

func (o *ListWorkspacesParams) SetTenantID(tenantID string)

SetTenantID adds the tenantId to the list workspaces params

func (*ListWorkspacesParams) SetThemeID 

func (o *ListWorkspacesParams) SetThemeID(themeID *string)

SetThemeID adds the themeId to the list workspaces params

func (*ListWorkspacesParams) SetTimeout 

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

SetTimeout adds the timeout to the list workspaces params

func (*ListWorkspacesParams) SetWorkspaceTypes 

func (o *ListWorkspacesParams) SetWorkspaceTypes(workspaceTypes *string)

SetWorkspaceTypes adds the workspaceTypes to the list workspaces params

func (*ListWorkspacesParams) WithAfterWorkspaceID 

func (o *ListWorkspacesParams) WithAfterWorkspaceID(afterWorkspaceID *string) *ListWorkspacesParams

WithAfterWorkspaceID adds the afterWorkspaceID to the list workspaces params

func (*ListWorkspacesParams) WithBeforeWorkspaceID 

func (o *ListWorkspacesParams) WithBeforeWorkspaceID(beforeWorkspaceID *string) *ListWorkspacesParams

WithBeforeWorkspaceID adds the beforeWorkspaceID to the list workspaces params

func (*ListWorkspacesParams) WithContext 

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

WithContext adds the context to the list workspaces params

func (*ListWorkspacesParams) WithDefaults 

func (o *ListWorkspacesParams) WithDefaults() *ListWorkspacesParams

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

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

func (*ListWorkspacesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list workspaces params

func (*ListWorkspacesParams) WithIfMatch 

func (o *ListWorkspacesParams) WithIfMatch(ifMatch *string) *ListWorkspacesParams

WithIfMatch adds the ifMatch to the list workspaces params

func (*ListWorkspacesParams) WithLimit 

func (o *ListWorkspacesParams) WithLimit(limit *int64) *ListWorkspacesParams

WithLimit adds the limit to the list workspaces params

func (*ListWorkspacesParams) WithOrder 

func (o *ListWorkspacesParams) WithOrder(order *string) *ListWorkspacesParams

WithOrder adds the order to the list workspaces params

func (*ListWorkspacesParams) WithSearchPhrase 

func (o *ListWorkspacesParams) WithSearchPhrase(searchPhrase *string) *ListWorkspacesParams

WithSearchPhrase adds the searchPhrase to the list workspaces params

func (*ListWorkspacesParams) WithSort 

func (o *ListWorkspacesParams) WithSort(sort *string) *ListWorkspacesParams

WithSort adds the sort to the list workspaces params

func (*ListWorkspacesParams) WithTemplate 

func (o *ListWorkspacesParams) WithTemplate(template *bool) *ListWorkspacesParams

WithTemplate adds the template to the list workspaces params

func (*ListWorkspacesParams) WithTenantID 

func (o *ListWorkspacesParams) WithTenantID(tenantID string) *ListWorkspacesParams

WithTenantID adds the tenantID to the list workspaces params

func (*ListWorkspacesParams) WithThemeID 

func (o *ListWorkspacesParams) WithThemeID(themeID *string) *ListWorkspacesParams

WithThemeID adds the themeID to the list workspaces params

func (*ListWorkspacesParams) WithTimeout 

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

WithTimeout adds the timeout to the list workspaces params

func (*ListWorkspacesParams) WithWorkspaceTypes 

func (o *ListWorkspacesParams) WithWorkspaceTypes(workspaceTypes *string) *ListWorkspacesParams

WithWorkspaceTypes adds the workspaceTypes to the list workspaces params

func (*ListWorkspacesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListWorkspacesReader 

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

ListWorkspacesReader is a Reader for the ListWorkspaces structure.

func (*ListWorkspacesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListWorkspacesTooManyRequests 

type ListWorkspacesTooManyRequests struct {
	Payload *models.Error
}

ListWorkspacesTooManyRequests describes a response with status code 429, with default header values.

Too many requests

func NewListWorkspacesTooManyRequests 

func NewListWorkspacesTooManyRequests() *ListWorkspacesTooManyRequests

NewListWorkspacesTooManyRequests creates a ListWorkspacesTooManyRequests with default headers values

func (*ListWorkspacesTooManyRequests) Code 

func (o *ListWorkspacesTooManyRequests) Code() int

Code gets the status code for the list workspaces too many requests response

func (*ListWorkspacesTooManyRequests) Error 

func (o *ListWorkspacesTooManyRequests) Error() string

func (*ListWorkspacesTooManyRequests) GetPayload 

func (o *ListWorkspacesTooManyRequests) GetPayload() *models.Error

func (*ListWorkspacesTooManyRequests) IsClientError 

func (o *ListWorkspacesTooManyRequests) IsClientError() bool

IsClientError returns true when this list workspaces too many requests response has a 4xx status code

func (*ListWorkspacesTooManyRequests) IsCode 

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

IsCode returns true when this list workspaces too many requests response a status code equal to that given

func (*ListWorkspacesTooManyRequests) IsRedirect 

func (o *ListWorkspacesTooManyRequests) IsRedirect() bool

IsRedirect returns true when this list workspaces too many requests response has a 3xx status code

func (*ListWorkspacesTooManyRequests) IsServerError 

func (o *ListWorkspacesTooManyRequests) IsServerError() bool

IsServerError returns true when this list workspaces too many requests response has a 5xx status code

func (*ListWorkspacesTooManyRequests) IsSuccess 

func (o *ListWorkspacesTooManyRequests) IsSuccess() bool

IsSuccess returns true when this list workspaces too many requests response has a 2xx status code

func (*ListWorkspacesTooManyRequests) String 

func (o *ListWorkspacesTooManyRequests) String() string

type ListWorkspacesUnauthorized 

type ListWorkspacesUnauthorized struct {
	Payload *models.Error
}

ListWorkspacesUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewListWorkspacesUnauthorized 

func NewListWorkspacesUnauthorized() *ListWorkspacesUnauthorized

NewListWorkspacesUnauthorized creates a ListWorkspacesUnauthorized with default headers values

func (*ListWorkspacesUnauthorized) Code 

func (o *ListWorkspacesUnauthorized) Code() int

Code gets the status code for the list workspaces unauthorized response

func (*ListWorkspacesUnauthorized) Error 

func (o *ListWorkspacesUnauthorized) Error() string

func (*ListWorkspacesUnauthorized) GetPayload 

func (o *ListWorkspacesUnauthorized) GetPayload() *models.Error

func (*ListWorkspacesUnauthorized) IsClientError 

func (o *ListWorkspacesUnauthorized) IsClientError() bool

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

func (*ListWorkspacesUnauthorized) IsCode 

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

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

func (*ListWorkspacesUnauthorized) IsRedirect 

func (o *ListWorkspacesUnauthorized) IsRedirect() bool

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

func (*ListWorkspacesUnauthorized) IsServerError 

func (o *ListWorkspacesUnauthorized) IsServerError() bool

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

func (*ListWorkspacesUnauthorized) IsSuccess 

func (o *ListWorkspacesUnauthorized) IsSuccess() bool

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

func (*ListWorkspacesUnauthorized) String 

func (o *ListWorkspacesUnauthorized) String() string

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.