Documentation
¶
Index ¶
- Constants
- type API
- func (s *API) CreateHuman(req *CreateHumanRequest, opts ...scw.RequestOption) (*Human, error)
- func (s *API) DeleteHuman(req *DeleteHumanRequest, opts ...scw.RequestOption) (*Human, error)
- func (s *API) GetHuman(req *GetHumanRequest, opts ...scw.RequestOption) (*Human, error)
- func (s *API) ListHumans(req *ListHumansRequest, opts ...scw.RequestOption) (*ListHumansResponse, error)
- func (s *API) Register(req *RegisterRequest, opts ...scw.RequestOption) (*RegisterResponse, error)
- func (s *API) RunHuman(req *RunHumanRequest, opts ...scw.RequestOption) (*Human, error)
- func (s *API) UpdateHuman(req *UpdateHumanRequest, opts ...scw.RequestOption) (*Human, error)
- type CreateHumanRequest
- type DeleteHumanRequest
- type EyeColors
- type GetHumanRequest
- type Human
- type HumanStatus
- type ListHumansRequest
- type ListHumansRequestOrderBy
- type ListHumansResponse
- type RegisterRequest
- type RegisterResponse
- type RunHumanRequest
- type UpdateHumanRequest
Constants ¶
View Source
const ( // EyeColorsUnknown is [insert doc]. EyeColorsUnknown = EyeColors("unknown") // EyeColorsAmber is [insert doc]. EyeColorsAmber = EyeColors("amber") // EyeColorsBlue is [insert doc]. EyeColorsBlue = EyeColors("blue") // EyeColorsBrown is [insert doc]. EyeColorsBrown = EyeColors("brown") // EyeColorsGray is [insert doc]. EyeColorsGray = EyeColors("gray") // EyeColorsGreen is [insert doc]. EyeColorsGreen = EyeColors("green") // EyeColorsHazel is [insert doc]. EyeColorsHazel = EyeColors("hazel") // EyeColorsRed is [insert doc]. EyeColorsRed = EyeColors("red") // EyeColorsViolet is [insert doc]. EyeColorsViolet = EyeColors("violet") )
View Source
const ( // HumanStatusUnknown is [insert doc]. HumanStatusUnknown = HumanStatus("unknown") // HumanStatusStopped is [insert doc]. HumanStatusStopped = HumanStatus("stopped") // HumanStatusRunning is [insert doc]. HumanStatusRunning = HumanStatus("running") )
View Source
const ( // ListHumansRequestOrderByCreatedAtAsc is [insert doc]. ListHumansRequestOrderByCreatedAtAsc = ListHumansRequestOrderBy("created_at_asc") // ListHumansRequestOrderByCreatedAtDesc is [insert doc]. ListHumansRequestOrderByCreatedAtDesc = ListHumansRequestOrderBy("created_at_desc") // ListHumansRequestOrderByUpdatedAtAsc is [insert doc]. ListHumansRequestOrderByUpdatedAtAsc = ListHumansRequestOrderBy("updated_at_asc") // ListHumansRequestOrderByUpdatedAtDesc is [insert doc]. ListHumansRequestOrderByUpdatedAtDesc = ListHumansRequestOrderBy("updated_at_desc") // ListHumansRequestOrderByHeightAsc is [insert doc]. ListHumansRequestOrderByHeightAsc = ListHumansRequestOrderBy("height_asc") // ListHumansRequestOrderByHeightDesc is [insert doc]. ListHumansRequestOrderByHeightDesc = ListHumansRequestOrderBy("height_desc") )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API no Auth Service for end-to-end testing.
func (*API) CreateHuman ¶
func (s *API) CreateHuman(req *CreateHumanRequest, opts ...scw.RequestOption) (*Human, error)
CreateHuman create a new human
func (*API) DeleteHuman ¶
func (s *API) DeleteHuman(req *DeleteHumanRequest, opts ...scw.RequestOption) (*Human, error)
DeleteHuman delete an existing human
Delete the human associated with the given id.
func (*API) GetHuman ¶
func (s *API) GetHuman(req *GetHumanRequest, opts ...scw.RequestOption) (*Human, error)
GetHuman get human details
Get the human details associated with the given id.
func (*API) ListHumans ¶
func (s *API) ListHumans(req *ListHumansRequest, opts ...scw.RequestOption) (*ListHumansResponse, error)
ListHumans list all your humans
func (*API) Register ¶
func (s *API) Register(req *RegisterRequest, opts ...scw.RequestOption) (*RegisterResponse, error)
func (*API) RunHuman ¶
func (s *API) RunHuman(req *RunHumanRequest, opts ...scw.RequestOption) (*Human, error)
func (*API) UpdateHuman ¶
func (s *API) UpdateHuman(req *UpdateHumanRequest, opts ...scw.RequestOption) (*Human, error)
UpdateHuman update an existing human
Update the human associated with the given id.
type CreateHumanRequest ¶
type CreateHumanRequest struct {
Region scw.Region `json:"-"`
Height float64 `json:"height"`
ShoeSize float32 `json:"shoe_size"`
AltitudeInMeter int32 `json:"altitude_in_meter"`
AltitudeInMillimeter int64 `json:"altitude_in_millimeter"`
FingersCount uint32 `json:"fingers_count"`
HairCount uint64 `json:"hair_count"`
IsHappy bool `json:"is_happy"`
// EyesColor
//
// Default value: unknown
EyesColor EyeColors `json:"eyes_color"`
ProjectID string `json:"project_id"`
}
type DeleteHumanRequest ¶
type EyeColors ¶
type EyeColors string
func (EyeColors) MarshalJSON ¶
func (*EyeColors) UnmarshalJSON ¶
type GetHumanRequest ¶
type Human ¶
type Human struct {
ID string `json:"id"`
ProjectID string `json:"project_id"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Height float64 `json:"height"`
ShoeSize float32 `json:"shoe_size"`
AltitudeInMeter int32 `json:"altitude_in_meter"`
AltitudeInMillimeter int64 `json:"altitude_in_millimeter"`
FingersCount uint32 `json:"fingers_count"`
HairCount uint64 `json:"hair_count"`
IsHappy bool `json:"is_happy"`
// EyesColor
//
// Default value: unknown
EyesColor EyeColors `json:"eyes_color"`
// Status
//
// Default value: unknown
Status HumanStatus `json:"status"`
Region scw.Region `json:"region"`
}
type HumanStatus ¶
type HumanStatus string
func (HumanStatus) MarshalJSON ¶
func (enum HumanStatus) MarshalJSON() ([]byte, error)
func (HumanStatus) String ¶
func (enum HumanStatus) String() string
func (*HumanStatus) UnmarshalJSON ¶
func (enum *HumanStatus) UnmarshalJSON(data []byte) error
type ListHumansRequest ¶
type ListHumansRequestOrderBy ¶
type ListHumansRequestOrderBy string
func (ListHumansRequestOrderBy) MarshalJSON ¶
func (enum ListHumansRequestOrderBy) MarshalJSON() ([]byte, error)
func (ListHumansRequestOrderBy) String ¶
func (enum ListHumansRequestOrderBy) String() string
func (*ListHumansRequestOrderBy) UnmarshalJSON ¶
func (enum *ListHumansRequestOrderBy) UnmarshalJSON(data []byte) error
type ListHumansResponse ¶
type ListHumansResponse struct {
TotalCount uint32 `json:"total_count"`
Humans []*Human `json:"humans"`
}
func (*ListHumansResponse) UnsafeAppend ¶
func (r *ListHumansResponse) UnsafeAppend(res interface{}) (int, scw.SdkError)
UnsafeAppend should not be used Internal usage only
func (*ListHumansResponse) UnsafeGetTotalCount ¶
func (r *ListHumansResponse) UnsafeGetTotalCount() int
UnsafeGetTotalCount should not be used Internal usage only
type RegisterRequest ¶
type RegisterResponse ¶
type RegisterResponse struct {
SecretKey string `json:"secret_key"`
}
type RunHumanRequest ¶
type UpdateHumanRequest ¶
type UpdateHumanRequest struct {
Region scw.Region `json:"-"`
HumanID string `json:"-"`
Height *float64 `json:"height"`
ShoeSize *float32 `json:"shoe_size"`
AltitudeInMeter *int32 `json:"altitude_in_meter"`
AltitudeInMillimeter *int64 `json:"altitude_in_millimeter"`
FingersCount *uint32 `json:"fingers_count"`
HairCount *uint64 `json:"hair_count"`
IsHappy *bool `json:"is_happy"`
// EyesColor
//
// Default value: unknown
EyesColor EyeColors `json:"eyes_color"`
}
Click to show internal directories.
Click to hide internal directories.