Categorygithub.com/G-Core/FastEdge-client-sdk-go
modulepackage
0.2.0
Repository: https://github.com/g-core/fastedge-client-sdk-go.git
Documentation: pkg.go.dev

# README

FastEdge Client SDK

This SDK allows to communicate with Gcore's FastEdge API.

SDK code is generated from OpenAPI spec. The maintainers of the repo keep generated SDK code up-to-date with FastEdge API spec so typically you would just need to update the code from repo.

However, if you need to re-generate SDK, run make generate. Please note that it requires oapi-codegen as a generator.

# Functions

GetSwagger returns the Swagger specification corresponding to the generated code in this file.
NewAddAppRequest calls the generic AddApp builder with application/json body.
NewAddAppRequestWithBody generates requests for AddApp with any type of body.
NewAddGroupRequest calls the generic AddGroup builder with application/json body.
NewAddGroupRequestWithBody generates requests for AddGroup with any type of body.
NewAddToGroupRequest calls the generic AddToGroup builder with application/json body.
NewAddToGroupRequestWithBody generates requests for AddToGroup with any type of body.
Creates a new ClientSDK, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewDelAppRequest generates requests for DelApp.
NewDelBinaryRequest generates requests for DelBinary.
NewDelFromGroupRequest generates requests for DelFromGroup.
NewDelGroupRequest generates requests for DelGroup.
NewGetAppIdByNameRequest generates requests for GetAppIdByName.
NewGetAppRequest generates requests for GetApp.
NewGetBinaryMetadataRequest generates requests for GetBinaryMetadata.
NewGetBinaryRequest generates requests for GetBinary.
NewGetClientMeRequest generates requests for GetClientMe.
NewGetGroupRequest generates requests for GetGroup.
NewLeaveGroupRequest generates requests for LeaveGroup.
NewListAppsRequest generates requests for ListApps.
NewListBinariesRequest generates requests for ListBinaries.
NewListGroupsRequest generates requests for ListGroups.
NewListLogsRequest generates requests for ListLogs.
NewPatchAppRequest calls the generic PatchApp builder with application/json body.
NewPatchAppRequestWithBody generates requests for PatchApp with any type of body.
NewStatsCallsRequest generates requests for StatsCalls.
NewStatsDurationRequest generates requests for StatsDuration.
NewStoreBinaryRequestWithBody generates requests for StoreBinary with any type of body.
NewUpdateAppRequest calls the generic UpdateApp builder with application/json body.
NewUpdateAppRequestWithBody generates requests for UpdateApp with any type of body.
NewUpdateBinaryMetadataRequest calls the generic UpdateBinaryMetadata builder with application/json body.
NewUpdateBinaryMetadataRequestWithBody generates requests for UpdateBinaryMetadata with any type of body.
NewUpdateGroupRequest calls the generic UpdateGroup builder with application/json body.
NewUpdateGroupRequestWithBody generates requests for UpdateGroup with any type of body.
ParseAddAppResponse parses an HTTP response from a AddAppWithResponse call.
ParseAddGroupResponse parses an HTTP response from a AddGroupWithResponse call.
ParseAddToGroupResponse parses an HTTP response from a AddToGroupWithResponse call.
ParseDelAppResponse parses an HTTP response from a DelAppWithResponse call.
ParseDelBinaryResponse parses an HTTP response from a DelBinaryWithResponse call.
ParseDelFromGroupResponse parses an HTTP response from a DelFromGroupWithResponse call.
ParseDelGroupResponse parses an HTTP response from a DelGroupWithResponse call.
ParseGetAppIdByNameResponse parses an HTTP response from a GetAppIdByNameWithResponse call.
ParseGetAppResponse parses an HTTP response from a GetAppWithResponse call.
ParseGetBinaryMetadataResponse parses an HTTP response from a GetBinaryMetadataWithResponse call.
ParseGetBinaryResponse parses an HTTP response from a GetBinaryWithResponse call.
ParseGetClientMeResponse parses an HTTP response from a GetClientMeWithResponse call.
ParseGetGroupResponse parses an HTTP response from a GetGroupWithResponse call.
ParseLeaveGroupResponse parses an HTTP response from a LeaveGroupWithResponse call.
ParseListAppsResponse parses an HTTP response from a ListAppsWithResponse call.
ParseListBinariesResponse parses an HTTP response from a ListBinariesWithResponse call.
ParseListGroupsResponse parses an HTTP response from a ListGroupsWithResponse call.
ParseListLogsResponse parses an HTTP response from a ListLogsWithResponse call.
ParsePatchAppResponse parses an HTTP response from a PatchAppWithResponse call.
ParseStatsCallsResponse parses an HTTP response from a StatsCallsWithResponse call.
ParseStatsDurationResponse parses an HTTP response from a StatsDurationWithResponse call.
ParseStoreBinaryResponse parses an HTTP response from a StoreBinaryWithResponse call.
ParseUpdateAppResponse parses an HTTP response from a UpdateAppWithResponse call.
ParseUpdateBinaryMetadataResponse parses an HTTP response from a UpdateBinaryMetadataWithResponse call.
ParseUpdateGroupResponse parses an HTTP response from a UpdateGroupWithResponse call.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

Defines values for AppLog.
Defines values for AppLog.
Defines values for ListLogsParamsSort.
Defines values for BinaryParamDataType.
Defines values for ListLogsParamsSort.
Defines values for BinaryParamDataType.
Defines values for BinaryParamDataType.
Defines values for BinaryParamDataType.
Defines values for UpdateAppJSONBodyLog.
Defines values for UpdateAppJSONBodyLog.

# Structs

No description provided by the author
AddGroupJSONBody defines parameters for AddGroup.
No description provided by the author
No description provided by the author
App defines model for app.
AppShort defines model for app_short.
Binary defines model for binary.
BinaryMetadata defines model for binary_metadata.
BinaryParam defines model for binary_param.
BinaryShort defines model for binary_short.
CallStats Edge app call statistics.
Client defines model for client.
ClientSDK which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
CountByStatus defines model for count_by_status.
No description provided by the author
No description provided by the author
No description provided by the author
DelGroupParams defines parameters for DelGroup.
No description provided by the author
DurationStats Edge app execution duration statistics.
Error defines model for error.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Group defines model for group.
GroupMember defines model for group_member.
GroupShort defines model for group_short.
No description provided by the author
ListAppsParams defines parameters for ListApps.
No description provided by the author
ListBinariesParams defines parameters for ListBinaries.
No description provided by the author
ListGroupsParams defines parameters for ListGroups.
No description provided by the author
ListLogsParams defines parameters for ListLogs.
No description provided by the author
Log defines model for log.
No description provided by the author
StatsCallsParams defines parameters for StatsCalls.
No description provided by the author
StatsDurationParams defines parameters for StatsDuration.
No description provided by the author
No description provided by the author
UpdateAppJSONBody defines parameters for UpdateApp.
No description provided by the author
No description provided by the author
UpdateGroupJSONBody defines parameters for UpdateGroup.
No description provided by the author

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

AddAppJSONRequestBody defines body for AddApp for application/json ContentType.
AddGroupJSONRequestBody defines body for AddGroup for application/json ContentType.
AddToGroupJSONRequestBody defines body for AddToGroup for application/json ContentType.
AppLog Logging channel (by default - kafka, which allows exploring logs with API).
BinaryParamDataType Parameter type.
ClientOption allows setting custom parameters during construction.
ListLogsParamsSort defines parameters for ListLogs.
PatchAppJSONRequestBody defines body for PatchApp for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.
UpdateAppJSONBodyLog defines parameters for UpdateApp.
UpdateAppJSONRequestBody defines body for UpdateApp for application/json ContentType.
UpdateBinaryMetadataJSONRequestBody defines body for UpdateBinaryMetadata for application/json ContentType.
UpdateGroupJSONRequestBody defines body for UpdateGroup for application/json ContentType.