Documentation
¶
Overview ¶
Package models provides data structures and types for the ARK SDK. This package contains profile and configuration models used to represent various ARK SDK entities and their properties for authentication and configuration management.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArkProfile ¶
type ArkProfile struct {
ProfileName string `json:"profile_name" mapstructure:"profile_name" validate:"required" flag:"profile-name" desc:"The name of the profile to use"`
ProfileDescription string `` /* 135-byte string literal not displayed */
AuthProfiles map[string]*auth.ArkAuthProfile `json:"auth_profiles" mapstructure:"auth_profile" validate:"required" flag:"-"`
}
ArkProfile represents a profile configuration for the ARK SDK. This structure contains the essential information needed to define a profile including its name, description, and associated authentication profiles. It supports JSON marshaling/unmarshaling with custom handling for auth profiles to ensure proper type safety during deserialization.
The struct fields include validation tags, mapstructure tags for configuration mapping, and flag tags for command-line interface integration.
Example usage:
profile := &ArkProfile{
ProfileName: "my-profile",
ProfileDescription: "Development environment profile",
AuthProfiles: make(map[string]*auth.ArkAuthProfile),
}
func (*ArkProfile) UnmarshalJSON ¶
func (p *ArkProfile) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for ArkProfile. It performs custom JSON unmarshaling to properly handle the AuthProfiles field which contains a map of authentication profiles that need special type handling.
The method uses an auxiliary struct with json.RawMessage to defer the unmarshaling of individual auth profiles, allowing for proper type conversion from the raw JSON data to the specific ArkAuthProfile type.
Parameters:
- data: JSON byte data containing the profile information to unmarshal
Returns:
- error: nil if unmarshaling succeeds, otherwise an error describing the failure
Example JSON input:
{
"profile_name": "my-profile",
"profile_description": "Development profile",
"auth_profiles": {
"default": {
"auth_type": "service_user",
"username": "user@example.com"
}
}
}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package common provides common models and utilities for AWS environment management and configuration handling within the ARK SDK.
|
Package common provides common models and utilities for AWS environment management and configuration handling within the ARK SDK. |
|
identity
Package identity provides data structures and types for ARK Identity directory services.
|
Package identity provides data structures and types for ARK Identity directory services. |