Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type BasicAuth
- type ChildTree
- type CodeError
- type CodeValidationError
- type CodeValidationFailures
- type Configuration
- type GenericOpenAPIError
- type JetDrop
- type JetDropApiService
- func (a *JetDropApiService) JetDropByID(ctx _context.Context, jetDropId string) (JetDropByIdResponse200, *_nethttp.Response, error)
- func (a *JetDropApiService) JetDropsByJetID(ctx _context.Context, jetId string, localVarOptionals *JetDropsByJetIDOpts) (JetDropsByJetIdResponse200, *_nethttp.Response, error)
- func (a *JetDropApiService) JetDropsByPulseNumber(ctx _context.Context, pulseNumber int64, ...) (JetDropsByJetIdResponse200, *_nethttp.Response, error)
- type JetDropByIdResponse200
- type JetDropByIdResponse200NextJetDropId
- type JetDropRecordsOpts
- type JetDrops
- type JetDropsByJetIDOpts
- type JetDropsByJetIdResponse200
- type JetDropsByPulseNumberOpts
- type NextPrevJetDrop
- type ObjectLifelineOpts
- type ObjectLifelineResponse200
- type ObjectLifelineResponse200Result
- type OriginalRequestByObjectOpts
- type OriginalRequests
- type Pulse
- type PulseApiService
- type PulseResponse200
- type Pulses
- type PulsesOpts
- type PulsesResponse200
- type PulsesResponse200ValidationFailures
- type Record
- type RecordAbstract
- type RecordApiService
- func (a *RecordApiService) JetDropRecords(ctx _context.Context, jetDropId string, localVarOptionals *JetDropRecordsOpts) (RecordsResponse200, *_nethttp.Response, error)
- func (a *RecordApiService) ObjectLifeline(ctx _context.Context, objectReference string, ...) (ObjectLifelineResponse200, *_nethttp.Response, error)
- type Records
- type RecordsResponse200
- type RecordsResponse200Result
- type Request
- type RequestResponse200
- type RequestResponse200Result
- type RequestResultAndStateApiService
- func (a *RequestResultAndStateApiService) OriginalRequestByObject(ctx _context.Context, objectReference string, ...) (RequestResponse200, *_nethttp.Response, error)
- func (a *RequestResultAndStateApiService) Originalrequest(ctx _context.Context, requestReference string) (RequestResponse200, *_nethttp.Response, error)
- func (a *RequestResultAndStateApiService) Request(ctx _context.Context, requestReference string) (RequestResponse200, *_nethttp.Response, error)
- func (a *RequestResultAndStateApiService) RequestTree(ctx _context.Context, requestReference string) (RequestTreeResponse200, *_nethttp.Response, error)
- func (a *RequestResultAndStateApiService) Result(ctx _context.Context, requestReference string) (ResultResponse200, *_nethttp.Response, error)
- type RequestTree
- type RequestTreeResponse200
- type RequestTreeResponse200Result
- type Result
- type ResultResponse200
- type SearchApiService
- type SearchJetDrop
- type SearchJetDropMeta
- type SearchLifeline
- type SearchLifelineMeta
- type SearchOriginalRequest
- type SearchOriginalRequestMeta
- type SearchPulse
- type SearchPulseMeta
- type SearchRequest
- type SearchRequestMeta
- type SearchResponse200
- type SearchResponse200Meta
- type SearchState
- type SearchStateMeta
- type ServerConfiguration
- type ServerVariable
- type State
- type States
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { JetDropApi *JetDropApiService PulseApi *PulseApiService RecordApi *RecordApiService RequestResultAndStateApi *RequestResultAndStateApiService SearchApi *SearchApiService // contains filtered or unexported fields }
APIClient manages communication with the Insolar Explorer API API v1.0.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
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.
func (*APIClient) ChangeBasePath ¶
ChangeBasePath changes base path to allow switching to mocks
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 APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
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.
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
NewAPIResponse returns a new APIResonse object.
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
type BasicAuth ¶
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type ChildTree ¶
type ChildTree struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Root of the request tree—an original request. Root bool `json:"root,omitempty"` // Reference to the new state that was created by the execution of this request. StateReference string `json:"state_reference,omitempty"` // Reference to an existing state that was called during the execution of this request. ExecutionStateReference string `json:"execution_state_reference,omitempty"` // Request reference. Reference string `json:"reference,omitempty"` // Reference to the result that was created by the execution of this request. ResultReference string `json:"result_reference,omitempty"` // True if request didn't change the object state. False otherwise. IsImmutable bool `json:"is_immutable,omitempty"` // An array of references to subsequent requests in the tree. NextRequests []string `json:"next_requests,omitempty"` // Reference to the object that called this request. CallerReference string `json:"caller_reference,omitempty"` // Internal debugging information. May be an empty string. TraceId string `json:"trace_id,omitempty"` // True if request is original. False otherwise. IsOriginalRequest bool `json:"is_original_request,omitempty"` // Reference to the parent request—a request that caused this one. ReasonReference string `json:"reason_reference,omitempty"` // Name of the smart contract method that called this request. Method string `json:"method,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. StateIndex string `json:"state_index,omitempty"` // Arguments of a smart contract method. Arguments string `json:"arguments,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` }
ChildTree Record abstract.
type CodeError ¶
type CodeError struct { // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` }
CodeError Response codes.
type CodeValidationError ¶
type CodeValidationError struct { // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
CodeValidationError Response codes.
type CodeValidationFailures ¶
type CodeValidationFailures struct { // Property name. Property string `json:"property,omitempty"` // Failure reason. FailureReason string `json:"failure_reason,omitempty"` }
CodeValidationFailures Validation failure.
type Configuration ¶
type Configuration struct { BasePath string `json:"basePath,omitempty"` 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 []ServerConfiguration HTTPClient *http.Client }
Configuration stores the configuration of the API client
func NewConfiguration ¶
func NewConfiguration() *Configuration
NewConfiguration returns a new Configuration object
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
AddDefaultHeader adds a new HTTP header to the default header in the request
type GenericOpenAPIError ¶
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
GenericOpenAPIError Provides access to the body, error and model on returned errors.
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 JetDrop ¶
type JetDrop struct { // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Next `jet_drop_id`. NextJetDropId []JetDropByIdResponse200NextJetDropId `json:"next_jet_drop_id,omitempty"` // Previous `jet_drop_id`. PrevJetDropId []JetDropByIdResponse200NextJetDropId `json:"prev_jet_drop_id,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Number of all records in the pulse. RecordAmount int64 `json:"record_amount,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
JetDrop Response codes.
type JetDropApiService ¶
type JetDropApiService service
JetDropApiService JetDropApi service
func (*JetDropApiService) JetDropByID ¶
func (a *JetDropApiService) JetDropByID(ctx _context.Context, jetDropId string) (JetDropByIdResponse200, *_nethttp.Response, error)
JetDropByID Jet drop by ID Gets the contents of a `jet_drop` given a `jet_drop_id` as a path parameter.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param jetDropId Combination of `jet_id` and `pulse_number` separated by a `:`.
@return JetDropByIdResponse200
func (*JetDropApiService) JetDropsByJetID ¶
func (a *JetDropApiService) JetDropsByJetID(ctx _context.Context, jetId string, localVarOptionals *JetDropsByJetIDOpts) (JetDropsByJetIdResponse200, *_nethttp.Response, error)
JetDropsByJetID Jet drops by jet ID Gets an array of jet drops given a `jet_id` as a path parameter. Optionally, specify filtering, sorting, and pagination parameters. For more information, refer to the [filtering, pagination, sorting](#section/Insolar-Explorer-API-documentation/Filtering-pagination-sorting) section.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param jetId Jet ID.
- @param optional nil or *JetDropsByJetIDOpts - Optional Parameters:
- @param "Limit" (optional.Int32) - Number of entries to show per page.
- @param "SortBy" (optional.String) - Sorts by the `pulse_number` attribute of the returned object. Can take two values that specify the sorting direction: descending (`pulse_number_desc`) or ascending (`pulse_number_asc`).
- @param "PulseNumberGte" (optional.Int32) - Starting point for a range of pulses—greater than or equal to the specified `pulse_number`.
- @param "PulseNumberGt" (optional.Int32) - Starting point for a range of pulses—greater than the specified `pulse_number`.
- @param "PulseNumberLte" (optional.Int32) - Ending point for a range of pulses—less than or equal to the specified `pulse_number`.
- @param "PulseNumberLt" (optional.Int32) - Ending point for a range of pulses—less than the specified `pulse_number`.
@return JetDropsByJetIdResponse200
func (*JetDropApiService) JetDropsByPulseNumber ¶
func (a *JetDropApiService) JetDropsByPulseNumber(ctx _context.Context, pulseNumber int64, localVarOptionals *JetDropsByPulseNumberOpts) (JetDropsByJetIdResponse200, *_nethttp.Response, error)
JetDropsByPulseNumber Jet drops by pulse number Gets an array of jet drops given a `pulse_number` as a path parameter. Optionally, specify pagination parameters. For more information, refer to the [filtering, pagination, sorting](#section/Insolar-Explorer-API-documentation/Filtering-pagination-sorting) section.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param pulseNumber Pulse number.
- @param optional nil or *JetDropsByPulseNumberOpts - Optional Parameters:
- @param "Limit" (optional.Int32) - Number of entries to show per page.
- @param "Offset" (optional.Int32) - Number of entries to skip from the starting point (`from_*`).
- @param "FromJetDropId" (optional.String) - Specific `jet_drop_id` to paginate from.
@return JetDropsByJetIdResponse200
type JetDropByIdResponse200 ¶
type JetDropByIdResponse200 struct { // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Next `jet_drop_id`. NextJetDropId []JetDropByIdResponse200NextJetDropId `json:"next_jet_drop_id,omitempty"` // Previous `jet_drop_id`. PrevJetDropId []JetDropByIdResponse200NextJetDropId `json:"prev_jet_drop_id,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Number of all records in the pulse. RecordAmount int64 `json:"record_amount,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
JetDropByIdResponse200 Response codes.
type JetDropByIdResponse200NextJetDropId ¶
type JetDropByIdResponse200NextJetDropId struct { // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` }
JetDropByIdResponse200NextJetDropId Jet Drop representation.
type JetDropRecordsOpts ¶
type JetDropRecordsOpts struct { Limit optional.Int32 Offset optional.Int32 FromIndex optional.String Type_ optional.String }
JetDropRecordsOpts Optional parameters for the method 'JetDropRecords'
type JetDrops ¶
type JetDrops struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []JetDropByIdResponse200 `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
JetDrops Response codes.
type JetDropsByJetIDOpts ¶
type JetDropsByJetIDOpts struct { Limit optional.Int32 SortBy optional.String PulseNumberGte optional.Int32 PulseNumberGt optional.Int32 PulseNumberLte optional.Int32 PulseNumberLt optional.Int32 }
JetDropsByJetIDOpts Optional parameters for the method 'JetDropsByJetID'
type JetDropsByJetIdResponse200 ¶
type JetDropsByJetIdResponse200 struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []JetDropByIdResponse200 `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
JetDropsByJetIdResponse200 Response codes.
type JetDropsByPulseNumberOpts ¶
type JetDropsByPulseNumberOpts struct { Limit optional.Int32 Offset optional.Int32 FromJetDropId optional.String }
JetDropsByPulseNumberOpts Optional parameters for the method 'JetDropsByPulseNumber'
type NextPrevJetDrop ¶
type NextPrevJetDrop struct { // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` }
NextPrevJetDrop Jet Drop representation.
type ObjectLifelineOpts ¶
type ObjectLifelineOpts struct { Limit optional.Int32 Offset optional.Int32 FromIndex optional.String SortBy optional.String PulseNumberGt optional.Int32 PulseNumberLt optional.Int32 TimestampGte optional.Int64 TimestampLte optional.Int64 }
ObjectLifelineOpts Optional parameters for the method 'ObjectLifeline'
type ObjectLifelineResponse200 ¶
type ObjectLifelineResponse200 struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []ObjectLifelineResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
ObjectLifelineResponse200 Response codes.
type ObjectLifelineResponse200Result ¶
type ObjectLifelineResponse200Result struct { // State reference. Reference string `json:"reference,omitempty"` // State type. Type string `json:"type,omitempty"` // Reference to the corresponding request. RequestReference string `json:"request_reference,omitempty"` // Reference to the parent object that caused creation of the given object. For example, a member object is a parent of its deposit account object. ParentReference string `json:"parent_reference,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` // Record payload. Payload string `json:"payload,omitempty"` // Object reference. ObjectReference string `json:"object_reference,omitempty"` // Reference to a previous record. PrevStateReference string `json:"prev_state_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` }
ObjectLifelineResponse200Result State representation.
type OriginalRequestByObjectOpts ¶
type OriginalRequestByObjectOpts struct { Limit optional.Int32 Offset optional.Int32 FromIndex optional.String SortBy optional.String PulseNumberGt optional.Int32 PulseNumberLt optional.Int32 TimestampGte optional.Int64 TimestampLte optional.Int64 }
OriginalRequestByObjectOpts Optional parameters for the method 'OriginalRequestByObject'
type OriginalRequests ¶
type OriginalRequests struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []RequestResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
OriginalRequests Response codes.
type Pulse ¶
type Pulse struct { // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Previous pulse number. PrevPulseNumber int64 `json:"prev_pulse_number,omitempty"` // Next pulse number. NextPulseNumber int64 `json:"next_pulse_number,omitempty"` // Number of all jet drops in the pulse. JetDropAmount int64 `json:"jet_drop_amount,omitempty"` // Number of all records in the pulse. RecordAmount int64 `json:"record_amount,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Pulse completion status. IsComplete bool `json:"is_complete,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
Pulse Response codes.
type PulseApiService ¶
type PulseApiService service
PulseApiService PulseApi service
func (*PulseApiService) Pulse ¶
func (a *PulseApiService) Pulse(ctx _context.Context, pulseNumber int64) (PulseResponse200, *_nethttp.Response, error)
Pulse Pulse Gets pulse by `pulse_number`.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param pulseNumber Pulse number.
@return PulseResponse200
func (*PulseApiService) Pulses ¶
func (a *PulseApiService) Pulses(ctx _context.Context, localVarOptionals *PulsesOpts) (PulsesResponse200, *_nethttp.Response, error)
Pulses Pulses Gets an array of pulses. Optionally, specify filtering, sorting, and pagination parameters. For more information, refer to the [filtering, pagination, sorting](#section/Insolar-Explorer-API-documentation/Filtering-pagination-sorting) section.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *PulsesOpts - Optional Parameters:
- @param "Limit" (optional.Int32) - Number of entries to show per page.
- @param "Offset" (optional.Int32) - Number of entries to skip from the starting point (`from_*`).
- @param "FromPulseNumber" (optional.Int64) - Specific `pulse_number` to paginate from.
- @param "TimestampGte" (optional.Int64) - Starting point for a range—greater than or equal to the specified `timestamp` in the Unix format.
- @param "TimestampLte" (optional.Int64) - Ending point for a range—less than or equal to the specified `timestamp` in the Unix format.
- @param "PulseNumberGt" (optional.Int32) - Starting point for a range of pulses—greater than the specified `pulse_number`.
- @param "PulseNumberGte" (optional.Int32) - Starting point for a range of pulses—greater than or equal to the specified `pulse_number`.
- @param "PulseNumberLt" (optional.Int32) - Ending point for a range of pulses—less than the specified `pulse_number`.
- @param "PulseNumberLte" (optional.Int32) - Ending point for a range of pulses—less than or equal to the specified `pulse_number`.
- @param "SortBy" (optional.String) - Sorting direction—ascending or descending relative to the monotonically increasing `pulse_number`.
@return PulsesResponse200
type PulseResponse200 ¶
type PulseResponse200 struct { // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Previous pulse number. PrevPulseNumber int64 `json:"prev_pulse_number,omitempty"` // Next pulse number. NextPulseNumber int64 `json:"next_pulse_number,omitempty"` // Number of all jet drops in the pulse. JetDropAmount int64 `json:"jet_drop_amount,omitempty"` // Number of all records in the pulse. RecordAmount int64 `json:"record_amount,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Pulse completion status. IsComplete bool `json:"is_complete,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
PulseResponse200 Response codes.
type Pulses ¶
type Pulses struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []PulseResponse200 `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
Pulses Response codes.
type PulsesOpts ¶
type PulsesOpts struct { Limit optional.Int32 Offset optional.Int32 FromPulseNumber optional.Int64 TimestampGte optional.Int64 TimestampLte optional.Int64 PulseNumberGt optional.Int32 PulseNumberGte optional.Int32 PulseNumberLt optional.Int32 PulseNumberLte optional.Int32 SortBy optional.String }
PulsesOpts Optional parameters for the method 'Pulses'
type PulsesResponse200 ¶
type PulsesResponse200 struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []PulseResponse200 `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
PulsesResponse200 Response codes.
type PulsesResponse200ValidationFailures ¶
type PulsesResponse200ValidationFailures struct { // Property name. Property string `json:"property,omitempty"` // Failure reason. FailureReason string `json:"failure_reason,omitempty"` }
PulsesResponse200ValidationFailures Validation failure.
type Record ¶
type Record struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Record reference. Reference string `json:"reference,omitempty"` // Reference to a previous record. PrevRecordReference string `json:"prev_record_reference,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` // Record type. Type string `json:"type,omitempty"` // Record payload. Payload string `json:"payload,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` }
Record Record abstract.
type RecordAbstract ¶
type RecordAbstract struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` }
RecordAbstract Record abstract.
type RecordApiService ¶
type RecordApiService service
RecordApiService RecordApi service
func (*RecordApiService) JetDropRecords ¶
func (a *RecordApiService) JetDropRecords(ctx _context.Context, jetDropId string, localVarOptionals *JetDropRecordsOpts) (RecordsResponse200, *_nethttp.Response, error)
JetDropRecords Records Gets an array of records of a jet drop given a `jet_drop_id` as a path parameter. Optionally, specify filtering and pagination parameters. For more information, refer to the [filtering, pagination, sorting](#section/Insolar-Explorer-API-documentation/Filtering-pagination-sorting) section.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param jetDropId Combination of `jet_id` and `pulse_number` separated by a `:`.
- @param optional nil or *JetDropRecordsOpts - Optional Parameters:
- @param "Limit" (optional.Int32) - Number of entries to show per page.
- @param "Offset" (optional.Int32) - Number of entries to skip from the starting point (`from_*`).
- @param "FromIndex" (optional.String) - Specific `index` to paginate from.
- @param "Type_" (optional.String) - Record type to filter the obtained records by.
@return RecordsResponse200
func (*RecordApiService) ObjectLifeline ¶
func (a *RecordApiService) ObjectLifeline(ctx _context.Context, objectReference string, localVarOptionals *ObjectLifelineOpts) (ObjectLifelineResponse200, *_nethttp.Response, error)
ObjectLifeline Object lifeline Gets an array of states of a lifeline given an `object_reference` as a path parameter. Optionally, specify filtering, sorting, and pagination parameters. For more information, refer to the [filtering, pagination, sorting](#section/Insolar-Explorer-API-documentation/Filtering-pagination-sorting) section.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param objectReference Object reference.
- @param optional nil or *ObjectLifelineOpts - Optional Parameters:
- @param "Limit" (optional.Int32) - Number of entries to show per page.
- @param "Offset" (optional.Int32) - Number of entries to skip from the starting point (`from_*`).
- @param "FromIndex" (optional.String) - Specific `index` to paginate from.
- @param "SortBy" (optional.String) - Sorts by the `index` attribute of the returned object. Can take two values that specify the sorting direction: descending (`index_desc`) or ascending (`index_asc`).
- @param "PulseNumberGt" (optional.Int32) - Starting point for a range of pulses—greater than the specified `pulse_number`.
- @param "PulseNumberLt" (optional.Int32) - Ending point for a range of pulses—less than the specified `pulse_number`.
- @param "TimestampGte" (optional.Int64) - Starting point for a range—greater than or equal to the specified `timestamp` in the Unix format.
- @param "TimestampLte" (optional.Int64) - Ending point for a range—less than or equal to the specified `timestamp` in the Unix format.
@return ObjectLifelineResponse200
type Records ¶
type Records struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []RecordsResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
Records Response codes.
type RecordsResponse200 ¶
type RecordsResponse200 struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []RecordsResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
RecordsResponse200 Response codes.
type RecordsResponse200Result ¶
type RecordsResponse200Result struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Record reference. Reference string `json:"reference,omitempty"` // Reference to a previous record. PrevRecordReference string `json:"prev_record_reference,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` // Record type. Type string `json:"type,omitempty"` // Record payload. Payload string `json:"payload,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` }
RecordsResponse200Result Record abstract.
type Request ¶
type Request struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Request reference. Reference string `json:"reference,omitempty"` // Reference to the object that called this request. CallerReference string `json:"caller_reference,omitempty"` // Internal debugging information. May be an empty string. TraceId string `json:"trace_id,omitempty"` // Reference to the parent request—a request that caused this one. ReasonReference string `json:"reason_reference,omitempty"` // Name of the smart contract method that called this request. Method string `json:"method,omitempty"` // True if request is original. False otherwise. IsOriginalRequest bool `json:"is_original_request,omitempty"` // Arguments of a smart contract method. Arguments string `json:"arguments,omitempty"` // True if request didn't change the object state. False otherwise. IsImmutable bool `json:"is_immutable,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` }
Request Record abstract.
type RequestResponse200 ¶
type RequestResponse200 struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []RequestResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
RequestResponse200 Response codes.
type RequestResponse200Result ¶
type RequestResponse200Result struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Request reference. Reference string `json:"reference,omitempty"` // Reference to the object that called this request. CallerReference string `json:"caller_reference,omitempty"` // Internal debugging information. May be an empty string. TraceId string `json:"trace_id,omitempty"` // Reference to the parent request—a request that caused this one. ReasonReference string `json:"reason_reference,omitempty"` // Name of the smart contract method that called this request. Method string `json:"method,omitempty"` // True if request is original. False otherwise. IsOriginalRequest bool `json:"is_original_request,omitempty"` // Arguments of a smart contract method. Arguments string `json:"arguments,omitempty"` // True if request didn't change the object state. False otherwise. IsImmutable bool `json:"is_immutable,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` }
RequestResponse200Result Record abstract.
type RequestResultAndStateApiService ¶
type RequestResultAndStateApiService service
RequestResultAndStateApiService RequestResultAndStateApi service
func (*RequestResultAndStateApiService) OriginalRequestByObject ¶
func (a *RequestResultAndStateApiService) OriginalRequestByObject(ctx _context.Context, objectReference string, localVarOptionals *OriginalRequestByObjectOpts) (RequestResponse200, *_nethttp.Response, error)
OriginalRequestByObject Original request by object Gets an array of original requests that changed the state of the object. Takes `object_reference` as a path parameter. Optionally, specify filtering, sorting, and pagination parameters. For more information, refer to the [filtering, pagination, sorting](#section/Insolar-Explorer-API-documentation/Filtering-pagination-sorting) section.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param objectReference Object reference.
- @param optional nil or *OriginalRequestByObjectOpts - Optional Parameters:
- @param "Limit" (optional.Int32) - Number of entries to show per page.
- @param "Offset" (optional.Int32) - Number of entries to skip from the starting point (`from_*`).
- @param "FromIndex" (optional.String) - Specific `index` to paginate from.
- @param "SortBy" (optional.String) - Sorts by the `index` attribute of the returned object. Can take two values that specify the sorting direction: descending (`index_desc`) or ascending (`index_asc`).
- @param "PulseNumberGt" (optional.Int32) - Starting point for a range of pulses—greater than the specified `pulse_number`.
- @param "PulseNumberLt" (optional.Int32) - Ending point for a range of pulses—less than the specified `pulse_number`.
- @param "TimestampGte" (optional.Int64) - Starting point for a range—greater than or equal to the specified `timestamp` in the Unix format.
- @param "TimestampLte" (optional.Int64) - Ending point for a range—less than or equal to the specified `timestamp` in the Unix format.
@return RequestResponse200
func (*RequestResultAndStateApiService) Originalrequest ¶
func (a *RequestResultAndStateApiService) Originalrequest(ctx _context.Context, requestReference string) (RequestResponse200, *_nethttp.Response, error)
Originalrequest Original request Gets the original request that caused the given request. Takes `request_reference` as a path parameter.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestReference Reference to a request or original request.
@return RequestResponse200
func (*RequestResultAndStateApiService) Request ¶
func (a *RequestResultAndStateApiService) Request(ctx _context.Context, requestReference string) (RequestResponse200, *_nethttp.Response, error)
Request Request Gets details of a request given a `request_reference` as a path parameter.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestReference Reference to a request or original request.
@return RequestResponse200
func (*RequestResultAndStateApiService) RequestTree ¶
func (a *RequestResultAndStateApiService) RequestTree(ctx _context.Context, requestReference string) (RequestTreeResponse200, *_nethttp.Response, error)
RequestTree Request tree Gets a request tree given a `request_reference` as a path parameter. The request tree is chain of requests each of which has a reference to a corresponding result and state.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestReference Reference to a request or original request.
@return RequestTreeResponse200
func (*RequestResultAndStateApiService) Result ¶
func (a *RequestResultAndStateApiService) Result(ctx _context.Context, requestReference string) (ResultResponse200, *_nethttp.Response, error)
Result Result Gets a corresponding result given a `request_reference` as a path parameter.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param requestReference Reference to a request or original request.
@return ResultResponse200
type RequestTree ¶
type RequestTree struct { // An array containing request details and references to the corresponding result and state. Result []RequestTreeResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
RequestTree Response codes.
type RequestTreeResponse200 ¶
type RequestTreeResponse200 struct { // An array containing request details and references to the corresponding result and state. Result []RequestTreeResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
RequestTreeResponse200 Response codes.
type RequestTreeResponse200Result ¶
type RequestTreeResponse200Result struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Root of the request tree—an original request. Root bool `json:"root,omitempty"` // Reference to the new state that was created by the execution of this request. StateReference string `json:"state_reference,omitempty"` // Reference to an existing state that was called during the execution of this request. ExecutionStateReference string `json:"execution_state_reference,omitempty"` // Request reference. Reference string `json:"reference,omitempty"` // Reference to the result that was created by the execution of this request. ResultReference string `json:"result_reference,omitempty"` // True if request didn't change the object state. False otherwise. IsImmutable bool `json:"is_immutable,omitempty"` // An array of references to subsequent requests in the tree. NextRequests []string `json:"next_requests,omitempty"` // Reference to the object that called this request. CallerReference string `json:"caller_reference,omitempty"` // Internal debugging information. May be an empty string. TraceId string `json:"trace_id,omitempty"` // True if request is original. False otherwise. IsOriginalRequest bool `json:"is_original_request,omitempty"` // Reference to the parent request—a request that caused this one. ReasonReference string `json:"reason_reference,omitempty"` // Name of the smart contract method that called this request. Method string `json:"method,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. StateIndex string `json:"state_index,omitempty"` // Arguments of a smart contract method. Arguments string `json:"arguments,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` }
RequestTreeResponse200Result Record abstract.
type Result ¶
type Result struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Result reference. Reference string `json:"reference,omitempty"` // Reference to the corresponding request. RequestReference string `json:"request_reference,omitempty"` // Result payload. Payload string `json:"payload,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
Result Response codes.
type ResultResponse200 ¶
type ResultResponse200 struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` // Result reference. Reference string `json:"reference,omitempty"` // Reference to the corresponding request. RequestReference string `json:"request_reference,omitempty"` // Result payload. Payload string `json:"payload,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
ResultResponse200 Response codes.
type SearchApiService ¶
type SearchApiService service
SearchApiService SearchApi service
func (*SearchApiService) Search ¶
func (a *SearchApiService) Search(ctx _context.Context, value string) (SearchResponse200, *_nethttp.Response, error)
Search Search Searches for an entity by its identifier. Entities and their identifiers may be one of the following: * Record—record reference * State-state by object * Jet drop—jet drop ID (combination of `jet_id` and `pulse_number`) * Pulse—pulse number * Lifeline—object reference * Original request—user request that comes from outside the Platform * Request—request one object made to another inside the Platform * Request tree—all connected requests for the given request. Each request in a request tree supplied with references to the corresponding state and response. Search takes any of the identifiers above as the `value` parameter, determines the identifier type and finds the corresponding entity. If the entity exists, search returns its type and meta-information.
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param value Searching value.
@return SearchResponse200
type SearchJetDrop ¶
type SearchJetDrop struct { // Result type. Type string `json:"type,omitempty"` Meta SearchJetDropMeta `json:"meta,omitempty"` }
SearchJetDrop Jet drop response.
type SearchJetDropMeta ¶
type SearchJetDropMeta struct { // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` }
SearchJetDropMeta Meta data.
type SearchLifeline ¶
type SearchLifeline struct { // Result type. Type string `json:"type,omitempty"` Meta SearchLifelineMeta `json:"meta,omitempty"` }
SearchLifeline Lifeline response.
type SearchLifelineMeta ¶
type SearchLifelineMeta struct { // Object reference. ObjectReference string `json:"object_reference,omitempty"` }
SearchLifelineMeta Meta data.
type SearchOriginalRequest ¶
type SearchOriginalRequest struct { // Result type. Type string `json:"type,omitempty"` Meta SearchOriginalRequestMeta `json:"meta,omitempty"` }
SearchOriginalRequest Original request response.
type SearchOriginalRequestMeta ¶
type SearchOriginalRequestMeta struct { // Original request reference. Reference string `json:"reference,omitempty"` }
SearchOriginalRequestMeta Meta data.
type SearchPulse ¶
type SearchPulse struct { // Result type. Type string `json:"type,omitempty"` Meta SearchPulseMeta `json:"meta,omitempty"` }
SearchPulse Pulse response.
type SearchPulseMeta ¶
type SearchPulseMeta struct { // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` }
SearchPulseMeta Meta data.
type SearchRequest ¶
type SearchRequest struct { // Result type. Type string `json:"type,omitempty"` Meta SearchRequestMeta `json:"meta,omitempty"` }
SearchRequest Request response.
type SearchRequestMeta ¶
type SearchRequestMeta struct { // Request reference. Reference string `json:"reference,omitempty"` }
SearchRequestMeta Meta data.
type SearchResponse200 ¶
type SearchResponse200 struct { // Result type. Type string `json:"type,omitempty"` Meta SearchResponse200Meta `json:"meta,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
SearchResponse200 Response codes.
type SearchResponse200Meta ¶
type SearchResponse200Meta struct { // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Original request reference. Reference string `json:"reference,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` }
SearchResponse200Meta Meta data.
type SearchState ¶
type SearchState struct { // Result type. Type string `json:"type,omitempty"` Meta SearchStateMeta `json:"meta,omitempty"` }
SearchState State response.
type SearchStateMeta ¶
type SearchStateMeta struct { // Reference to the corresponding object. ObjectReference string `json:"object_reference,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` }
SearchStateMeta Meta data.
type ServerConfiguration ¶
type ServerConfiguration struct { Url string Description string Variables map[string]ServerVariable }
ServerConfiguration stores the information about a server
type ServerVariable ¶
ServerVariable stores the information about a server variable
type State ¶
type State struct { // State reference. Reference string `json:"reference,omitempty"` // State type. Type string `json:"type,omitempty"` // Reference to the corresponding request. RequestReference string `json:"request_reference,omitempty"` // Reference to the parent object that caused creation of the given object. For example, a member object is a parent of its deposit account object. ParentReference string `json:"parent_reference,omitempty"` // Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object. PrototypeReference string `json:"prototype_reference,omitempty"` // Record payload. Payload string `json:"payload,omitempty"` // Object reference. ObjectReference string `json:"object_reference,omitempty"` // Reference to a previous record. PrevStateReference string `json:"prev_state_reference,omitempty"` // Record hash. Hash string `json:"hash,omitempty"` // Jet ID. JetId string `json:"jet_id,omitempty"` // Combination of `jet_id` and `pulse_number` separated by a `:`. JetDropId string `json:"jet_drop_id,omitempty"` // Pulse number. PulseNumber int64 `json:"pulse_number,omitempty"` // Record number in a `jet drop`. Order int64 `json:"order,omitempty"` // Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop. Index string `json:"index,omitempty"` // Unix timestamp. Timestamp int64 `json:"timestamp,omitempty"` }
State State representation.
type States ¶
type States struct { // Actual number of existing entries. May be higher or lower than the specified `limit`. Total int64 `json:"total,omitempty"` // Array with a number entries as specified by filtering and pagination parameters. Result []ObjectLifelineResponse200Result `json:"result,omitempty"` // Error code received from the backend services. Code string `json:"code,omitempty"` // Short error description. Message string `json:"message,omitempty"` // Additional information about the error. Description string `json:"description,omitempty"` // Array containing incorrect parameters/properties. ValidationFailures []PulsesResponse200ValidationFailures `json:"validation_failures,omitempty"` }
States Response codes.
Source Files ¶
- api_jet_drop.go
- api_pulse.go
- api_record.go
- api_request_result_and_state.go
- api_search.go
- client.go
- configuration.go
- model_child_tree.go
- model_code_error.go
- model_code_validation_error.go
- model_code_validation_failures.go
- model_jet_drop.go
- model_jet_drop_by_id_response200.go
- model_jet_drop_by_id_response200_next_jet_drop_id.go
- model_jet_drops.go
- model_jet_drops_by_jet_id_response200.go
- model_next_prev_jet_drop.go
- model_object_lifeline_response200.go
- model_object_lifeline_response200_result.go
- model_original_requests.go
- model_pulse.go
- model_pulse_response200.go
- model_pulses.go
- model_pulses_response200.go
- model_pulses_response200_validation_failures.go
- model_record.go
- model_record_abstract.go
- model_records.go
- model_records_response200.go
- model_records_response200_result.go
- model_request.go
- model_request_response200.go
- model_request_response200_result.go
- model_request_tree.go
- model_request_tree_response200.go
- model_request_tree_response200_result.go
- model_result.go
- model_result_response200.go
- model_search_jet_drop.go
- model_search_jet_drop_meta.go
- model_search_lifeline.go
- model_search_lifeline_meta.go
- model_search_original_request.go
- model_search_original_request_meta.go
- model_search_pulse.go
- model_search_pulse_meta.go
- model_search_request.go
- model_search_request_meta.go
- model_search_response200.go
- model_search_response200_meta.go
- model_search_state.go
- model_search_state_meta.go
- model_state.go
- model_states.go
- response.go