upload

package
v2.31.2 Latest Latest
Warning

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

Go to latest
Published: Jun 30, 2025 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithContentTypeApplicationJSON

func WithContentTypeApplicationJSON(r *runtime.ClientOperation)

WithContentTypeApplicationJSON sets the Content-Type header to "application/json".

func WithContentTypeMultipartFormData

func WithContentTypeMultipartFormData(r *runtime.ClientOperation)

WithContentTypeMultipartFormData sets the Content-Type header to "multipart/form-data".

Types

type Client

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

Client for upload API

func (*Client) SetTransport

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

SetTransport changes the transport on the client

func (*Client) UploadTLS

func (a *Client) UploadTLS(params *UploadTLSParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UploadTLSNoContent, error)
UploadTLS uploads TLS files

Use this environment(endpoint) to upload TLS files.

**Access policy**: administrator

type ClientOption

type ClientOption func(*runtime.ClientOperation)

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

func WithContentType

func WithContentType(mime string) ClientOption

WithContentType allows the client to force the Content-Type header to negotiate a specific Consumer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService

type ClientService interface {
	UploadTLS(params *UploadTLSParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UploadTLSNoContent, 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 upload API client.

func NewClientWithBasicAuth

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

New creates a new upload 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 upload 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 UploadTLSBadRequest

type UploadTLSBadRequest struct {
}

UploadTLSBadRequest describes a response with status code 400, with default header values.

Invalid request

func NewUploadTLSBadRequest

func NewUploadTLSBadRequest() *UploadTLSBadRequest

NewUploadTLSBadRequest creates a UploadTLSBadRequest with default headers values

func (*UploadTLSBadRequest) Code

func (o *UploadTLSBadRequest) Code() int

Code gets the status code for the upload Tls bad request response

func (*UploadTLSBadRequest) Error

func (o *UploadTLSBadRequest) Error() string

func (*UploadTLSBadRequest) IsClientError

func (o *UploadTLSBadRequest) IsClientError() bool

IsClientError returns true when this upload Tls bad request response has a 4xx status code

func (*UploadTLSBadRequest) IsCode

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

IsCode returns true when this upload Tls bad request response a status code equal to that given

func (*UploadTLSBadRequest) IsRedirect

func (o *UploadTLSBadRequest) IsRedirect() bool

IsRedirect returns true when this upload Tls bad request response has a 3xx status code

func (*UploadTLSBadRequest) IsServerError

func (o *UploadTLSBadRequest) IsServerError() bool

IsServerError returns true when this upload Tls bad request response has a 5xx status code

func (*UploadTLSBadRequest) IsSuccess

func (o *UploadTLSBadRequest) IsSuccess() bool

IsSuccess returns true when this upload Tls bad request response has a 2xx status code

func (*UploadTLSBadRequest) String

func (o *UploadTLSBadRequest) String() string

type UploadTLSInternalServerError

type UploadTLSInternalServerError struct {
}

UploadTLSInternalServerError describes a response with status code 500, with default header values.

Server error

func NewUploadTLSInternalServerError

func NewUploadTLSInternalServerError() *UploadTLSInternalServerError

NewUploadTLSInternalServerError creates a UploadTLSInternalServerError with default headers values

func (*UploadTLSInternalServerError) Code

Code gets the status code for the upload Tls internal server error response

func (*UploadTLSInternalServerError) Error

func (*UploadTLSInternalServerError) IsClientError

func (o *UploadTLSInternalServerError) IsClientError() bool

IsClientError returns true when this upload Tls internal server error response has a 4xx status code

func (*UploadTLSInternalServerError) IsCode

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

IsCode returns true when this upload Tls internal server error response a status code equal to that given

func (*UploadTLSInternalServerError) IsRedirect

func (o *UploadTLSInternalServerError) IsRedirect() bool

IsRedirect returns true when this upload Tls internal server error response has a 3xx status code

func (*UploadTLSInternalServerError) IsServerError

func (o *UploadTLSInternalServerError) IsServerError() bool

IsServerError returns true when this upload Tls internal server error response has a 5xx status code

func (*UploadTLSInternalServerError) IsSuccess

func (o *UploadTLSInternalServerError) IsSuccess() bool

IsSuccess returns true when this upload Tls internal server error response has a 2xx status code

func (*UploadTLSInternalServerError) String

type UploadTLSNoContent

type UploadTLSNoContent struct {
}

UploadTLSNoContent describes a response with status code 204, with default header values.

Success

func NewUploadTLSNoContent

func NewUploadTLSNoContent() *UploadTLSNoContent

NewUploadTLSNoContent creates a UploadTLSNoContent with default headers values

func (*UploadTLSNoContent) Code

func (o *UploadTLSNoContent) Code() int

Code gets the status code for the upload Tls no content response

func (*UploadTLSNoContent) Error

func (o *UploadTLSNoContent) Error() string

func (*UploadTLSNoContent) IsClientError

func (o *UploadTLSNoContent) IsClientError() bool

IsClientError returns true when this upload Tls no content response has a 4xx status code

func (*UploadTLSNoContent) IsCode

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

IsCode returns true when this upload Tls no content response a status code equal to that given

func (*UploadTLSNoContent) IsRedirect

func (o *UploadTLSNoContent) IsRedirect() bool

IsRedirect returns true when this upload Tls no content response has a 3xx status code

func (*UploadTLSNoContent) IsServerError

func (o *UploadTLSNoContent) IsServerError() bool

IsServerError returns true when this upload Tls no content response has a 5xx status code

func (*UploadTLSNoContent) IsSuccess

func (o *UploadTLSNoContent) IsSuccess() bool

IsSuccess returns true when this upload Tls no content response has a 2xx status code

func (*UploadTLSNoContent) String

func (o *UploadTLSNoContent) String() string

type UploadTLSParams

type UploadTLSParams struct {

	/* Certificate.

	   TLS file type. Valid values are 'ca', 'cert' or 'key'.
	*/
	Certificate string

	/* File.

	   The file to upload
	*/
	File runtime.NamedReadCloser

	/* Folder.

	   Folder where the TLS file will be stored. Will be created if not existing
	*/
	Folder string

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

UploadTLSParams contains all the parameters to send to the API endpoint

for the upload TLS operation.

Typically these are written to a http.Request.

func NewUploadTLSParams

func NewUploadTLSParams() *UploadTLSParams

NewUploadTLSParams creates a new UploadTLSParams 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 NewUploadTLSParamsWithContext

func NewUploadTLSParamsWithContext(ctx context.Context) *UploadTLSParams

NewUploadTLSParamsWithContext creates a new UploadTLSParams object with the ability to set a context for a request.

func NewUploadTLSParamsWithHTTPClient

func NewUploadTLSParamsWithHTTPClient(client *http.Client) *UploadTLSParams

NewUploadTLSParamsWithHTTPClient creates a new UploadTLSParams object with the ability to set a custom HTTPClient for a request.

func NewUploadTLSParamsWithTimeout

func NewUploadTLSParamsWithTimeout(timeout time.Duration) *UploadTLSParams

NewUploadTLSParamsWithTimeout creates a new UploadTLSParams object with the ability to set a timeout on a request.

func (*UploadTLSParams) SetCertificate

func (o *UploadTLSParams) SetCertificate(certificate string)

SetCertificate adds the certificate to the upload TLS params

func (*UploadTLSParams) SetContext

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

SetContext adds the context to the upload TLS params

func (*UploadTLSParams) SetDefaults

func (o *UploadTLSParams) SetDefaults()

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

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

func (*UploadTLSParams) SetFile

func (o *UploadTLSParams) SetFile(file runtime.NamedReadCloser)

SetFile adds the file to the upload TLS params

func (*UploadTLSParams) SetFolder

func (o *UploadTLSParams) SetFolder(folder string)

SetFolder adds the folder to the upload TLS params

func (*UploadTLSParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the upload TLS params

func (*UploadTLSParams) SetTimeout

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

SetTimeout adds the timeout to the upload TLS params

func (*UploadTLSParams) WithCertificate

func (o *UploadTLSParams) WithCertificate(certificate string) *UploadTLSParams

WithCertificate adds the certificate to the upload TLS params

func (*UploadTLSParams) WithContext

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

WithContext adds the context to the upload TLS params

func (*UploadTLSParams) WithDefaults

func (o *UploadTLSParams) WithDefaults() *UploadTLSParams

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

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

func (*UploadTLSParams) WithFile

WithFile adds the file to the upload TLS params

func (*UploadTLSParams) WithFolder

func (o *UploadTLSParams) WithFolder(folder string) *UploadTLSParams

WithFolder adds the folder to the upload TLS params

func (*UploadTLSParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the upload TLS params

func (*UploadTLSParams) WithTimeout

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

WithTimeout adds the timeout to the upload TLS params

func (*UploadTLSParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type UploadTLSReader

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

UploadTLSReader is a Reader for the UploadTLS structure.

func (*UploadTLSReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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