Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Timedeprecated
- func PtrBool(v bool) *booldeprecated
- func PtrFloat32(v float32) *float32deprecated
- func PtrFloat64(v float64) *float64deprecated
- func PtrInt(v int) *intdeprecated
- func PtrInt32(v int32) *int32deprecated
- func PtrInt64(v int64) *int64deprecated
- func PtrString(v string) *stringdeprecated
- func PtrTime(v time.Time) *time.Timedeprecated
- type APIClientdeprecated
- type APIKeydeprecated
- type APIResponsedeprecated
- type BasicAuthdeprecated
- type Configurationdeprecated
- func NewConfiguration() *Configurationdeprecated
- type Failuredeprecated
- func NewFailure(error_ FailureError) *Failuredeprecated
- func NewFailureWithDefaults() *Failuredeprecated
- type FailureErrordeprecated
- func (o *FailureError) GetDetails() string
- func (o *FailureError) GetDetailsOk() (*string, bool)
- func (o *FailureError) GetReason() string
- func (o *FailureError) GetReasonOk() (*string, bool)
- func (o *FailureError) HasDetails() bool
- func (o FailureError) MarshalJSON() ([]byte, error)
- func (o *FailureError) SetDetails(v string)
- func (o *FailureError) SetReason(v string)
- type GenericOpenAPIErrordeprecated
- type NullableBooldeprecated
- type NullableFailuredeprecated
- type NullableFailureErrordeprecated
- func (v NullableFailureError) Get() *FailureError
- func (v NullableFailureError) IsSet() bool
- func (v NullableFailureError) MarshalJSON() ([]byte, error)
- func (v *NullableFailureError) Set(val *FailureError)
- func (v *NullableFailureError) UnmarshalJSON(src []byte) error
- func (v *NullableFailureError) Unset()
- type NullableFloat32deprecated
- type NullableFloat64deprecated
- type NullableIntdeprecated
- type NullableInt32deprecated
- type NullableInt64deprecated
- type NullablePindeprecated
- type NullablePinResultsdeprecated
- type NullablePinStatusdeprecated
- type NullableStatusdeprecated
- type NullableStringdeprecated
- type NullableTimedeprecated
- type Pindeprecated
- func NewPin(cid string) *Pindeprecated
- func NewPinWithDefaults() *Pindeprecated
- func (o *Pin) GetCid() string
- func (o *Pin) GetCidOk() (*string, bool)
- func (o *Pin) GetMeta() map[string]string
- func (o *Pin) GetMetaOk() (*map[string]string, bool)
- func (o *Pin) GetName() string
- func (o *Pin) GetNameOk() (*string, bool)
- func (o *Pin) GetOrigins() []string
- func (o *Pin) GetOriginsOk() (*[]string, bool)
- func (o *Pin) HasMeta() bool
- func (o *Pin) HasName() bool
- func (o *Pin) HasOrigins() bool
- func (o Pin) MarshalJSON() ([]byte, error)
- func (o *Pin) SetCid(v string)
- func (o *Pin) SetMeta(v map[string]string)
- func (o *Pin) SetName(v string)
- func (o *Pin) SetOrigins(v []string)
- type PinResultsdeprecated
- func (o *PinResults) GetCount() int32
- func (o *PinResults) GetCountOk() (*int32, bool)
- func (o *PinResults) GetResults() []PinStatus
- func (o *PinResults) GetResultsOk() (*[]PinStatus, bool)
- func (o PinResults) MarshalJSON() ([]byte, error)
- func (o *PinResults) SetCount(v int32)
- func (o *PinResults) SetResults(v []PinStatus)
- type PinStatusdeprecated
- func (o *PinStatus) GetCreated() time.Time
- func (o *PinStatus) GetCreatedOk() (*time.Time, bool)
- func (o *PinStatus) GetDelegates() []string
- func (o *PinStatus) GetDelegatesOk() (*[]string, bool)
- func (o *PinStatus) GetInfo() map[string]string
- func (o *PinStatus) GetInfoOk() (*map[string]string, bool)
- func (o *PinStatus) GetPin() Pin
- func (o *PinStatus) GetPinOk() (*Pin, bool)
- func (o *PinStatus) GetRequestid() string
- func (o *PinStatus) GetRequestidOk() (*string, bool)
- func (o *PinStatus) GetStatus() Status
- func (o *PinStatus) GetStatusOk() (*Status, bool)
- func (o *PinStatus) HasInfo() bool
- func (o PinStatus) MarshalJSON() ([]byte, error)
- func (o *PinStatus) SetCreated(v time.Time)
- func (o *PinStatus) SetDelegates(v []string)
- func (o *PinStatus) SetInfo(v map[string]string)
- func (o *PinStatus) SetPin(v Pin)
- func (o *PinStatus) SetRequestid(v string)
- func (o *PinStatus) SetStatus(v Status)
- type PinsApiServicedeprecated
- func (a *PinsApiService) PinsGet(ctx _context.Context) apiPinsGetRequest
- func (a *PinsApiService) PinsPost(ctx _context.Context) apiPinsPostRequest
- func (a *PinsApiService) PinsRequestidDelete(ctx _context.Context, requestid string) apiPinsRequestidDeleteRequest
- func (a *PinsApiService) PinsRequestidGet(ctx _context.Context, requestid string) apiPinsRequestidGetRequest
- func (a *PinsApiService) PinsRequestidPost(ctx _context.Context, requestid string) apiPinsRequestidPostRequest
- type ServerConfigurationdeprecated
- type ServerConfigurationsdeprecated
- type ServerVariabledeprecated
- type Statusdeprecated
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextOAuth2 ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextBasicAuth ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextAccessToken ContextAccessToken = contextKey("accesstoken") // ContextAPIKeys takes a string apikey as authentication for the request // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextAPIKeys ContextAPIKeys = contextKey("apiKeys") // ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextHttpSignatureAuth ContextHttpSignatureAuth = contextKey("httpsignature") // ContextServerIndex uses a server configuration from the index. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextServerIndex ContextServerIndex = contextKey("serverIndex") // ContextOperationServerIndices uses a server configuration from the index mapping. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextOperationServerIndices ContextOperationServerIndices = contextKey("serverOperationIndices") // ContextServerVariables overrides a server configuration variables. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextServerVariables ContextServerVariables = contextKey("serverVariables") // ContextOperationServerVariables overrides a server configuration variables using operation specific values. // // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ContextOperationServerVariables ContextOperationServerVariables = contextKey("serverOperationVariables") )
Functions ¶
func CacheExpires
deprecated
func PtrFloat32
deprecated
func PtrFloat64
deprecated
Types ¶
type APIClient
deprecated
type APIClient struct { PinsApi *PinsApiService // contains filtered or unexported fields }
APIClient manages communication with the IPFS Pinning Service API API v0.1.1 In most cases there should be only one, shared, APIClient.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.APIClient
func NewAPIClient
deprecated
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewAPIClient
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
type APIResponse
deprecated
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the OpenAPI operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
APIResponse stores the API response returned by the server.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.APIResponse
func NewAPIResponse
deprecated
func NewAPIResponse(r *http.Response) *APIResponse
NewAPIResponse returns a new APIResonse object.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewAPIResponse
func NewAPIResponseWithError
deprecated
func NewAPIResponseWithError(errorMessage string) *APIResponse
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewAPIResponseWithError
type BasicAuth
deprecated
type Configuration
deprecated
type Configuration struct { Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` Debug bool `json:"debug,omitempty"` Servers ServerConfigurations OperationServers map[string]ServerConfigurations HTTPClient *http.Client }
Configuration stores the configuration of the API client
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.Configuration
func NewConfiguration
deprecated
func NewConfiguration() *Configuration
NewConfiguration returns a new Configuration object
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewConfiguration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
AddDefaultHeader adds a new HTTP header to the default header in the request
func (*Configuration) ServerURLWithContext ¶
ServerURLWithContext returns a new server URL given an endpoint
type Failure
deprecated
type Failure struct {
Error FailureError `json:"error"`
}
Failure Response for a failed request
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.Failure
func NewFailure
deprecated
func NewFailure(error_ FailureError) *Failure
NewFailure instantiates a new Failure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewFailure
func NewFailureWithDefaults
deprecated
func NewFailureWithDefaults() *Failure
NewFailureWithDefaults instantiates a new Failure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewFailureWithDefaults
func (*Failure) GetError ¶
func (o *Failure) GetError() FailureError
GetError returns the Error field value
func (*Failure) GetErrorOk ¶
func (o *Failure) GetErrorOk() (*FailureError, bool)
GetErrorOk returns a tuple with the Error field value and a boolean to check if the value has been set.
func (Failure) MarshalJSON ¶
type FailureError
deprecated
type FailureError struct { // Mandatory string identifying the type of error Reason string `json:"reason"` // Optional, longer description of the error; may include UUID of transaction for support, links to documentation etc Details *string `json:"details,omitempty"` }
FailureError struct for FailureError
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.FailureError
func NewFailureError
deprecated
func NewFailureError(reason string) *FailureError
NewFailureError instantiates a new FailureError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewFailureError
func NewFailureErrorWithDefaults
deprecated
func NewFailureErrorWithDefaults() *FailureError
NewFailureErrorWithDefaults instantiates a new FailureError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewFailureErrorWithDefaults
func (*FailureError) GetDetails ¶
func (o *FailureError) GetDetails() string
GetDetails returns the Details field value if set, zero value otherwise.
func (*FailureError) GetDetailsOk ¶
func (o *FailureError) GetDetailsOk() (*string, bool)
GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set.
func (*FailureError) GetReason ¶
func (o *FailureError) GetReason() string
GetReason returns the Reason field value
func (*FailureError) GetReasonOk ¶
func (o *FailureError) GetReasonOk() (*string, bool)
GetReasonOk returns a tuple with the Reason field value and a boolean to check if the value has been set.
func (*FailureError) HasDetails ¶
func (o *FailureError) HasDetails() bool
HasDetails returns a boolean if a field has been set.
func (FailureError) MarshalJSON ¶
func (o FailureError) MarshalJSON() ([]byte, error)
func (*FailureError) SetDetails ¶
func (o *FailureError) SetDetails(v string)
SetDetails gets a reference to the given string and assigns it to the Details field.
func (*FailureError) SetReason ¶
func (o *FailureError) SetReason(v string)
SetReason sets field value
type GenericOpenAPIError
deprecated
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.GenericOpenAPIError
func (GenericOpenAPIError) Body ¶
func (e GenericOpenAPIError) Body() []byte
Body returns the raw bytes of the response
func (GenericOpenAPIError) Error ¶
func (e GenericOpenAPIError) Error() string
Error returns non-empty string if there was an error.
func (GenericOpenAPIError) Model ¶
func (e GenericOpenAPIError) Model() interface{}
Model returns the unpacked model of the error
type NullableBool
deprecated
type NullableBool struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableBool
func NewNullableBool
deprecated
func NewNullableBool(val *bool) *NullableBool
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableBool
func (NullableBool) Get ¶
func (v NullableBool) Get() *bool
func (NullableBool) IsSet ¶
func (v NullableBool) IsSet() bool
func (NullableBool) MarshalJSON ¶
func (v NullableBool) MarshalJSON() ([]byte, error)
func (*NullableBool) Set ¶
func (v *NullableBool) Set(val *bool)
func (*NullableBool) UnmarshalJSON ¶
func (v *NullableBool) UnmarshalJSON(src []byte) error
func (*NullableBool) Unset ¶
func (v *NullableBool) Unset()
type NullableFailure
deprecated
type NullableFailure struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableFailure
func NewNullableFailure
deprecated
func NewNullableFailure(val *Failure) *NullableFailure
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableFailure
func (NullableFailure) Get ¶
func (v NullableFailure) Get() *Failure
func (NullableFailure) IsSet ¶
func (v NullableFailure) IsSet() bool
func (NullableFailure) MarshalJSON ¶
func (v NullableFailure) MarshalJSON() ([]byte, error)
func (*NullableFailure) Set ¶
func (v *NullableFailure) Set(val *Failure)
func (*NullableFailure) UnmarshalJSON ¶
func (v *NullableFailure) UnmarshalJSON(src []byte) error
func (*NullableFailure) Unset ¶
func (v *NullableFailure) Unset()
type NullableFailureError
deprecated
type NullableFailureError struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableFailureError
func NewNullableFailureError
deprecated
func NewNullableFailureError(val *FailureError) *NullableFailureError
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableFailureError
func (NullableFailureError) Get ¶
func (v NullableFailureError) Get() *FailureError
func (NullableFailureError) IsSet ¶
func (v NullableFailureError) IsSet() bool
func (NullableFailureError) MarshalJSON ¶
func (v NullableFailureError) MarshalJSON() ([]byte, error)
func (*NullableFailureError) Set ¶
func (v *NullableFailureError) Set(val *FailureError)
func (*NullableFailureError) UnmarshalJSON ¶
func (v *NullableFailureError) UnmarshalJSON(src []byte) error
func (*NullableFailureError) Unset ¶
func (v *NullableFailureError) Unset()
type NullableFloat32
deprecated
type NullableFloat32 struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableFloat32
func NewNullableFloat32
deprecated
func NewNullableFloat32(val *float32) *NullableFloat32
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableFloat32
func (NullableFloat32) Get ¶
func (v NullableFloat32) Get() *float32
func (NullableFloat32) IsSet ¶
func (v NullableFloat32) IsSet() bool
func (NullableFloat32) MarshalJSON ¶
func (v NullableFloat32) MarshalJSON() ([]byte, error)
func (*NullableFloat32) Set ¶
func (v *NullableFloat32) Set(val *float32)
func (*NullableFloat32) UnmarshalJSON ¶
func (v *NullableFloat32) UnmarshalJSON(src []byte) error
func (*NullableFloat32) Unset ¶
func (v *NullableFloat32) Unset()
type NullableFloat64
deprecated
type NullableFloat64 struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableFloat64
func NewNullableFloat64
deprecated
func NewNullableFloat64(val *float64) *NullableFloat64
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableFloat64
func (NullableFloat64) Get ¶
func (v NullableFloat64) Get() *float64
func (NullableFloat64) IsSet ¶
func (v NullableFloat64) IsSet() bool
func (NullableFloat64) MarshalJSON ¶
func (v NullableFloat64) MarshalJSON() ([]byte, error)
func (*NullableFloat64) Set ¶
func (v *NullableFloat64) Set(val *float64)
func (*NullableFloat64) UnmarshalJSON ¶
func (v *NullableFloat64) UnmarshalJSON(src []byte) error
func (*NullableFloat64) Unset ¶
func (v *NullableFloat64) Unset()
type NullableInt
deprecated
type NullableInt struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableInt
func NewNullableInt
deprecated
func NewNullableInt(val *int) *NullableInt
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableInt
func (NullableInt) Get ¶
func (v NullableInt) Get() *int
func (NullableInt) IsSet ¶
func (v NullableInt) IsSet() bool
func (NullableInt) MarshalJSON ¶
func (v NullableInt) MarshalJSON() ([]byte, error)
func (*NullableInt) Set ¶
func (v *NullableInt) Set(val *int)
func (*NullableInt) UnmarshalJSON ¶
func (v *NullableInt) UnmarshalJSON(src []byte) error
func (*NullableInt) Unset ¶
func (v *NullableInt) Unset()
type NullableInt32
deprecated
type NullableInt32 struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableInt32
func NewNullableInt32
deprecated
func NewNullableInt32(val *int32) *NullableInt32
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableInt32
func (NullableInt32) Get ¶
func (v NullableInt32) Get() *int32
func (NullableInt32) IsSet ¶
func (v NullableInt32) IsSet() bool
func (NullableInt32) MarshalJSON ¶
func (v NullableInt32) MarshalJSON() ([]byte, error)
func (*NullableInt32) Set ¶
func (v *NullableInt32) Set(val *int32)
func (*NullableInt32) UnmarshalJSON ¶
func (v *NullableInt32) UnmarshalJSON(src []byte) error
func (*NullableInt32) Unset ¶
func (v *NullableInt32) Unset()
type NullableInt64
deprecated
type NullableInt64 struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableInt64
func NewNullableInt64
deprecated
func NewNullableInt64(val *int64) *NullableInt64
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableInt64
func (NullableInt64) Get ¶
func (v NullableInt64) Get() *int64
func (NullableInt64) IsSet ¶
func (v NullableInt64) IsSet() bool
func (NullableInt64) MarshalJSON ¶
func (v NullableInt64) MarshalJSON() ([]byte, error)
func (*NullableInt64) Set ¶
func (v *NullableInt64) Set(val *int64)
func (*NullableInt64) UnmarshalJSON ¶
func (v *NullableInt64) UnmarshalJSON(src []byte) error
func (*NullableInt64) Unset ¶
func (v *NullableInt64) Unset()
type NullablePin
deprecated
type NullablePin struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullablePin
func NewNullablePin
deprecated
func NewNullablePin(val *Pin) *NullablePin
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullablePin
func (NullablePin) Get ¶
func (v NullablePin) Get() *Pin
func (NullablePin) IsSet ¶
func (v NullablePin) IsSet() bool
func (NullablePin) MarshalJSON ¶
func (v NullablePin) MarshalJSON() ([]byte, error)
func (*NullablePin) Set ¶
func (v *NullablePin) Set(val *Pin)
func (*NullablePin) UnmarshalJSON ¶
func (v *NullablePin) UnmarshalJSON(src []byte) error
func (*NullablePin) Unset ¶
func (v *NullablePin) Unset()
type NullablePinResults
deprecated
type NullablePinResults struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullablePinResults
func NewNullablePinResults
deprecated
func NewNullablePinResults(val *PinResults) *NullablePinResults
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullablePinResults
func (NullablePinResults) Get ¶
func (v NullablePinResults) Get() *PinResults
func (NullablePinResults) IsSet ¶
func (v NullablePinResults) IsSet() bool
func (NullablePinResults) MarshalJSON ¶
func (v NullablePinResults) MarshalJSON() ([]byte, error)
func (*NullablePinResults) Set ¶
func (v *NullablePinResults) Set(val *PinResults)
func (*NullablePinResults) UnmarshalJSON ¶
func (v *NullablePinResults) UnmarshalJSON(src []byte) error
func (*NullablePinResults) Unset ¶
func (v *NullablePinResults) Unset()
type NullablePinStatus
deprecated
type NullablePinStatus struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullablePinStatus
func NewNullablePinStatus
deprecated
func NewNullablePinStatus(val *PinStatus) *NullablePinStatus
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullablePinStatus
func (NullablePinStatus) Get ¶
func (v NullablePinStatus) Get() *PinStatus
func (NullablePinStatus) IsSet ¶
func (v NullablePinStatus) IsSet() bool
func (NullablePinStatus) MarshalJSON ¶
func (v NullablePinStatus) MarshalJSON() ([]byte, error)
func (*NullablePinStatus) Set ¶
func (v *NullablePinStatus) Set(val *PinStatus)
func (*NullablePinStatus) UnmarshalJSON ¶
func (v *NullablePinStatus) UnmarshalJSON(src []byte) error
func (*NullablePinStatus) Unset ¶
func (v *NullablePinStatus) Unset()
type NullableStatus
deprecated
type NullableStatus struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableStatus
func NewNullableStatus
deprecated
func NewNullableStatus(val *Status) *NullableStatus
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableStatus
func (NullableStatus) Get ¶
func (v NullableStatus) Get() *Status
func (NullableStatus) IsSet ¶
func (v NullableStatus) IsSet() bool
func (NullableStatus) MarshalJSON ¶
func (v NullableStatus) MarshalJSON() ([]byte, error)
func (*NullableStatus) Set ¶
func (v *NullableStatus) Set(val *Status)
func (*NullableStatus) UnmarshalJSON ¶
func (v *NullableStatus) UnmarshalJSON(src []byte) error
func (*NullableStatus) Unset ¶
func (v *NullableStatus) Unset()
type NullableString
deprecated
type NullableString struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableString
func NewNullableString
deprecated
func NewNullableString(val *string) *NullableString
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableString
func (NullableString) Get ¶
func (v NullableString) Get() *string
func (NullableString) IsSet ¶
func (v NullableString) IsSet() bool
func (NullableString) MarshalJSON ¶
func (v NullableString) MarshalJSON() ([]byte, error)
func (*NullableString) Set ¶
func (v *NullableString) Set(val *string)
func (*NullableString) UnmarshalJSON ¶
func (v *NullableString) UnmarshalJSON(src []byte) error
func (*NullableString) Unset ¶
func (v *NullableString) Unset()
type NullableTime
deprecated
type NullableTime struct {
// contains filtered or unexported fields
}
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NullableTime
func NewNullableTime
deprecated
func NewNullableTime(val *time.Time) *NullableTime
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewNullableTime
func (NullableTime) Get ¶
func (v NullableTime) Get() *time.Time
func (NullableTime) IsSet ¶
func (v NullableTime) IsSet() bool
func (NullableTime) MarshalJSON ¶
func (v NullableTime) MarshalJSON() ([]byte, error)
func (*NullableTime) Set ¶
func (v *NullableTime) Set(val *time.Time)
func (*NullableTime) UnmarshalJSON ¶
func (v *NullableTime) UnmarshalJSON(src []byte) error
func (*NullableTime) Unset ¶
func (v *NullableTime) Unset()
type Pin
deprecated
type Pin struct { // Content Identifier (CID) to be pinned recursively Cid string `json:"cid"` // Optional name for pinned data; can be used for lookups later Name *string `json:"name,omitempty"` // Optional list of multiaddrs known to provide the data Origins *[]string `json:"origins,omitempty"` // Optional metadata for pin object Meta *map[string]string `json:"meta,omitempty"` }
Pin Pin object
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.Pin
func NewPin
deprecated
NewPin instantiates a new Pin object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewPin
func NewPinWithDefaults
deprecated
func NewPinWithDefaults() *Pin
NewPinWithDefaults instantiates a new Pin object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewPinWithDefaults
func (*Pin) GetCidOk ¶
GetCidOk returns a tuple with the Cid field value and a boolean to check if the value has been set.
func (*Pin) GetMetaOk ¶
GetMetaOk returns a tuple with the Meta field value if set, nil otherwise and a boolean to check if the value has been set.
func (*Pin) GetNameOk ¶
GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.
func (*Pin) GetOrigins ¶
GetOrigins returns the Origins field value if set, zero value otherwise.
func (*Pin) GetOriginsOk ¶
GetOriginsOk returns a tuple with the Origins field value if set, nil otherwise and a boolean to check if the value has been set.
func (*Pin) HasOrigins ¶
HasOrigins returns a boolean if a field has been set.
func (Pin) MarshalJSON ¶
func (*Pin) SetMeta ¶
SetMeta gets a reference to the given map[string]string and assigns it to the Meta field.
func (*Pin) SetName ¶
SetName gets a reference to the given string and assigns it to the Name field.
func (*Pin) SetOrigins ¶
SetOrigins gets a reference to the given []string and assigns it to the Origins field.
type PinResults
deprecated
type PinResults struct { // The total number of pin objects that exist for passed query filters Count int32 `json:"count"` // An array of PinStatus results Results []PinStatus `json:"results"` }
PinResults Response used for listing pin objects matching request
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.PinResults
func NewPinResults
deprecated
func NewPinResults(count int32, results []PinStatus) *PinResults
NewPinResults instantiates a new PinResults object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewPinResults
func NewPinResultsWithDefaults
deprecated
func NewPinResultsWithDefaults() *PinResults
NewPinResultsWithDefaults instantiates a new PinResults object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewPinResultsWithDefaults
func (*PinResults) GetCount ¶
func (o *PinResults) GetCount() int32
GetCount returns the Count field value
func (*PinResults) GetCountOk ¶
func (o *PinResults) GetCountOk() (*int32, bool)
GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.
func (*PinResults) GetResults ¶
func (o *PinResults) GetResults() []PinStatus
GetResults returns the Results field value
func (*PinResults) GetResultsOk ¶
func (o *PinResults) GetResultsOk() (*[]PinStatus, bool)
GetResultsOk returns a tuple with the Results field value and a boolean to check if the value has been set.
func (PinResults) MarshalJSON ¶
func (o PinResults) MarshalJSON() ([]byte, error)
func (*PinResults) SetResults ¶
func (o *PinResults) SetResults(v []PinStatus)
SetResults sets field value
type PinStatus
deprecated
type PinStatus struct { // Globally unique identifier of the pin request; can be used to check the status of ongoing pinning, or pin removal Requestid string `json:"requestid"` Status Status `json:"status"` // Immutable timestamp indicating when a pin request entered a pinning service; can be used for filtering results and pagination Created time.Time `json:"created"` Pin Pin `json:"pin"` // List of multiaddrs designated by pinning service for transferring any new data from external peers Delegates []string `json:"delegates"` // Optional info for PinStatus response Info *map[string]string `json:"info,omitempty"` }
PinStatus Pin object with status
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.PinStatus
func NewPinStatus
deprecated
func NewPinStatus(requestid string, status Status, created time.Time, pin Pin, delegates []string) *PinStatus
NewPinStatus instantiates a new PinStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewPinStatus
func NewPinStatusWithDefaults
deprecated
func NewPinStatusWithDefaults() *PinStatus
NewPinStatusWithDefaults instantiates a new PinStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.NewPinStatusWithDefaults
func (*PinStatus) GetCreated ¶
GetCreated returns the Created field value
func (*PinStatus) GetCreatedOk ¶
GetCreatedOk returns a tuple with the Created field value and a boolean to check if the value has been set.
func (*PinStatus) GetDelegates ¶
GetDelegates returns the Delegates field value
func (*PinStatus) GetDelegatesOk ¶
GetDelegatesOk returns a tuple with the Delegates field value and a boolean to check if the value has been set.
func (*PinStatus) GetInfoOk ¶
GetInfoOk returns a tuple with the Info field value if set, nil otherwise and a boolean to check if the value has been set.
func (*PinStatus) GetPinOk ¶
GetPinOk returns a tuple with the Pin field value and a boolean to check if the value has been set.
func (*PinStatus) GetRequestid ¶
GetRequestid returns the Requestid field value
func (*PinStatus) GetRequestidOk ¶
GetRequestidOk returns a tuple with the Requestid field value and a boolean to check if the value has been set.
func (*PinStatus) GetStatusOk ¶
GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.
func (PinStatus) MarshalJSON ¶
func (*PinStatus) SetCreated ¶
SetCreated sets field value
func (*PinStatus) SetDelegates ¶
SetDelegates sets field value
func (*PinStatus) SetInfo ¶
SetInfo gets a reference to the given map[string]string and assigns it to the Info field.
func (*PinStatus) SetRequestid ¶
SetRequestid sets field value
type PinsApiService
deprecated
type PinsApiService service
PinsApiService PinsApi service
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.PinsApiService
func (*PinsApiService) PinsGet ¶
func (a *PinsApiService) PinsGet(ctx _context.Context) apiPinsGetRequest
PinsGet List pin objects List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return apiPinsGetRequest
func (*PinsApiService) PinsPost ¶
func (a *PinsApiService) PinsPost(ctx _context.Context) apiPinsPostRequest
PinsPost Add pin object Add a new pin object for the current access token
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return apiPinsPostRequest
func (*PinsApiService) PinsRequestidDelete ¶
func (a *PinsApiService) PinsRequestidDelete(ctx _context.Context, requestid string) apiPinsRequestidDeleteRequest
PinsRequestidDelete Remove pin object Remove a pin object
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestid
@return apiPinsRequestidDeleteRequest
func (*PinsApiService) PinsRequestidGet ¶
func (a *PinsApiService) PinsRequestidGet(ctx _context.Context, requestid string) apiPinsRequestidGetRequest
PinsRequestidGet Get pin object Get a pin object and its status
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestid
@return apiPinsRequestidGetRequest
func (*PinsApiService) PinsRequestidPost ¶
func (a *PinsApiService) PinsRequestidPost(ctx _context.Context, requestid string) apiPinsRequestidPostRequest
PinsRequestidPost Replace pin object Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins)
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestid
@return apiPinsRequestidPostRequest
type ServerConfiguration
deprecated
type ServerConfiguration struct { URL string Description string Variables map[string]ServerVariable }
ServerConfiguration stores the information about a server
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ServerConfiguration
type ServerConfigurations
deprecated
type ServerConfigurations []ServerConfiguration
ServerConfigurations stores multiple ServerConfiguration items
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.ServerConfigurations
type ServerVariable
deprecated
type Status
deprecated
type Status string
Status Status a pin object can have at a pinning service
Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.Status
const ( // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.QUEUED QUEUED Status = "queued" // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.PINNING PINNING Status = "pinning" // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.PINNED PINNED Status = "pinned" // Deprecated: use github.com/ipfs/boxo/pinning/remote/client/openapi.FAILED FAILED Status = "failed" )
List of Status