folders

package
v0.6.0 Latest Latest
Warning

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

 Go to latest Published: Nov 17, 2022 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 folders API

func (*Client) GetFolders 

func (a *Client) GetFolders(params *GetFoldersParams, opts ...ClientOption) (*GetFoldersOK, error)

GetFolders gets folders

Get all folders within the current organization

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 is the option for Client methods

type ClientService 

type ClientService interface {
	GetFolders(params *GetFoldersParams, opts ...ClientOption) (*GetFoldersOK, 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 folders API client.

type GetFoldersForbidden 

type GetFoldersForbidden struct {
	Payload *models.ServiceErrorResponse
}

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

Forbidden

func NewGetFoldersForbidden 

func NewGetFoldersForbidden() *GetFoldersForbidden

NewGetFoldersForbidden creates a GetFoldersForbidden with default headers values

func (*GetFoldersForbidden) Error 

func (o *GetFoldersForbidden) Error() string

func (*GetFoldersForbidden) GetPayload 

func (o *GetFoldersForbidden) GetPayload() *models.ServiceErrorResponse

func (*GetFoldersForbidden) IsClientError 

func (o *GetFoldersForbidden) IsClientError() bool

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

func (*GetFoldersForbidden) IsCode 

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

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

func (*GetFoldersForbidden) IsRedirect 

func (o *GetFoldersForbidden) IsRedirect() bool

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

func (*GetFoldersForbidden) IsServerError 

func (o *GetFoldersForbidden) IsServerError() bool

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

func (*GetFoldersForbidden) IsSuccess 

func (o *GetFoldersForbidden) IsSuccess() bool

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

func (*GetFoldersForbidden) String 

func (o *GetFoldersForbidden) String() string

type GetFoldersOK 

type GetFoldersOK struct {
	Payload *models.FolderResult
}

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

successful operation

func NewGetFoldersOK 

func NewGetFoldersOK() *GetFoldersOK

NewGetFoldersOK creates a GetFoldersOK with default headers values

func (*GetFoldersOK) Error 

func (o *GetFoldersOK) Error() string

func (*GetFoldersOK) GetPayload 

func (o *GetFoldersOK) GetPayload() *models.FolderResult

func (*GetFoldersOK) IsClientError 

func (o *GetFoldersOK) IsClientError() bool

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

func (*GetFoldersOK) IsCode 

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

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

func (*GetFoldersOK) IsRedirect 

func (o *GetFoldersOK) IsRedirect() bool

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

func (*GetFoldersOK) IsServerError 

func (o *GetFoldersOK) IsServerError() bool

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

func (*GetFoldersOK) IsSuccess 

func (o *GetFoldersOK) IsSuccess() bool

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

func (*GetFoldersOK) String 

func (o *GetFoldersOK) String() string

type GetFoldersParams 

type GetFoldersParams struct {

	/* DollarCount.

	   Flag which when specified, regardless of the assigned value, shows the total number of records. If the collection has a filter it shows the number of records matching the filter.
	*/
	DollarCount *bool

	/* DollarFilter.

	   Filter the results by a specified predicate expression. Operators: eq, ne, and, or.
	*/
	DollarFilter *string

	/* DollarSelect.

	   Select a subset of properties to include in the response.
	*/
	DollarSelect *string

	/* DollarSkip.

	   Number of records you want to skip.
	*/
	DollarSkip *int64

	/* DollarTop.

	   Number of records you want to get.
	*/
	DollarTop *int64

	/* APIVersion.

	   The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
	*/
	APIVersion string

	/* CloudAccountID.

	   The ID of a vcenter cloud account.
	*/
	CloudAccountID *string

	/* ExternalRegionID.

	   The external unique identifier of the region associated with the vcenter cloud account.
	*/
	ExternalRegionID *string

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

GetFoldersParams contains all the parameters to send to the API endpoint 

for the get folders operation.

Typically these are written to a http.Request.

func NewGetFoldersParams 

func NewGetFoldersParams() *GetFoldersParams

NewGetFoldersParams creates a new GetFoldersParams 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 NewGetFoldersParamsWithContext 

func NewGetFoldersParamsWithContext(ctx context.Context) *GetFoldersParams

NewGetFoldersParamsWithContext creates a new GetFoldersParams object with the ability to set a context for a request.

func NewGetFoldersParamsWithHTTPClient 

func NewGetFoldersParamsWithHTTPClient(client *http.Client) *GetFoldersParams

NewGetFoldersParamsWithHTTPClient creates a new GetFoldersParams object with the ability to set a custom HTTPClient for a request.

func NewGetFoldersParamsWithTimeout 

func NewGetFoldersParamsWithTimeout(timeout time.Duration) *GetFoldersParams

NewGetFoldersParamsWithTimeout creates a new GetFoldersParams object with the ability to set a timeout on a request.

func (*GetFoldersParams) SetAPIVersion 

func (o *GetFoldersParams) SetAPIVersion(aPIVersion string)

SetAPIVersion adds the apiVersion to the get folders params

func (*GetFoldersParams) SetCloudAccountID 

func (o *GetFoldersParams) SetCloudAccountID(cloudAccountID *string)

SetCloudAccountID adds the cloudAccountId to the get folders params

func (*GetFoldersParams) SetContext 

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

SetContext adds the context to the get folders params

func (*GetFoldersParams) SetDefaults 

func (o *GetFoldersParams) SetDefaults()

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

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

func (*GetFoldersParams) SetDollarCount 

func (o *GetFoldersParams) SetDollarCount(dollarCount *bool)

SetDollarCount adds the dollarCount to the get folders params

func (*GetFoldersParams) SetDollarFilter 

func (o *GetFoldersParams) SetDollarFilter(dollarFilter *string)

SetDollarFilter adds the dollarFilter to the get folders params

func (*GetFoldersParams) SetDollarSelect 

func (o *GetFoldersParams) SetDollarSelect(dollarSelect *string)

SetDollarSelect adds the dollarSelect to the get folders params

func (*GetFoldersParams) SetDollarSkip 

func (o *GetFoldersParams) SetDollarSkip(dollarSkip *int64)

SetDollarSkip adds the dollarSkip to the get folders params

func (*GetFoldersParams) SetDollarTop 

func (o *GetFoldersParams) SetDollarTop(dollarTop *int64)

SetDollarTop adds the dollarTop to the get folders params

func (*GetFoldersParams) SetExternalRegionID 

func (o *GetFoldersParams) SetExternalRegionID(externalRegionID *string)

SetExternalRegionID adds the externalRegionId to the get folders params

func (*GetFoldersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get folders params

func (*GetFoldersParams) SetTimeout 

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

SetTimeout adds the timeout to the get folders params

func (*GetFoldersParams) WithAPIVersion 

func (o *GetFoldersParams) WithAPIVersion(aPIVersion string) *GetFoldersParams

WithAPIVersion adds the aPIVersion to the get folders params

func (*GetFoldersParams) WithCloudAccountID 

func (o *GetFoldersParams) WithCloudAccountID(cloudAccountID *string) *GetFoldersParams

WithCloudAccountID adds the cloudAccountID to the get folders params

func (*GetFoldersParams) WithContext 

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

WithContext adds the context to the get folders params

func (*GetFoldersParams) WithDefaults 

func (o *GetFoldersParams) WithDefaults() *GetFoldersParams

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

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

func (*GetFoldersParams) WithDollarCount 

func (o *GetFoldersParams) WithDollarCount(dollarCount *bool) *GetFoldersParams

WithDollarCount adds the dollarCount to the get folders params

func (*GetFoldersParams) WithDollarFilter 

func (o *GetFoldersParams) WithDollarFilter(dollarFilter *string) *GetFoldersParams

WithDollarFilter adds the dollarFilter to the get folders params

func (*GetFoldersParams) WithDollarSelect 

func (o *GetFoldersParams) WithDollarSelect(dollarSelect *string) *GetFoldersParams

WithDollarSelect adds the dollarSelect to the get folders params

func (*GetFoldersParams) WithDollarSkip 

func (o *GetFoldersParams) WithDollarSkip(dollarSkip *int64) *GetFoldersParams

WithDollarSkip adds the dollarSkip to the get folders params

func (*GetFoldersParams) WithDollarTop 

func (o *GetFoldersParams) WithDollarTop(dollarTop *int64) *GetFoldersParams

WithDollarTop adds the dollarTop to the get folders params

func (*GetFoldersParams) WithExternalRegionID 

func (o *GetFoldersParams) WithExternalRegionID(externalRegionID *string) *GetFoldersParams

WithExternalRegionID adds the externalRegionID to the get folders params

func (*GetFoldersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get folders params

func (*GetFoldersParams) WithTimeout 

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

WithTimeout adds the timeout to the get folders params

func (*GetFoldersParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetFoldersReader 

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

GetFoldersReader is a Reader for the GetFolders structure.

func (*GetFoldersReader) ReadResponse 

func (o *GetFoldersReader) 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.