Documentation
¶
Index ¶
- func CreateApiMaintenancePostRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- func CreateApiSettingsAuthorizedKeysDeleteRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- func CreateApiSettingsAuthorizedKeysPostRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- func CreateApiSettingsPutRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- func CreateApiStartPostRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- func CreateApiUpgradePostRequestBodyFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- type ApiConfigcheckRequestBuilder
- type ApiConfigureRequestBuilder
- type ApiMaintenancePostRequestBody
- func (m *ApiMaintenancePostRequestBody) GetAdditionalData() map[string]any
- func (m *ApiMaintenancePostRequestBody) GetFieldDeserializers() ...
- func (m *ApiMaintenancePostRequestBody) GetMaintenance() *string
- func (m *ApiMaintenancePostRequestBody) Serialize(...) error
- func (m *ApiMaintenancePostRequestBody) SetAdditionalData(value map[string]any)
- func (m *ApiMaintenancePostRequestBody) SetMaintenance(value *string)
- type ApiMaintenancePostRequestBodyable
- type ApiMaintenanceRequestBuilder
- func (m *ApiMaintenanceRequestBuilder) Get(ctx context.Context, ...) (...)
- func (m *ApiMaintenanceRequestBuilder) Post(ctx context.Context, body ApiMaintenancePostRequestBodyable, ...) (...)
- func (m *ApiMaintenanceRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ApiMaintenanceRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiMaintenancePostRequestBodyable, ...) (...)
- func (m *ApiMaintenanceRequestBuilder) WithUrl(rawUrl string) *ApiMaintenanceRequestBuilder
- type ApiRequestBuilder
- func (m *ApiRequestBuilder) Configcheck() *ApiConfigcheckRequestBuilder
- func (m *ApiRequestBuilder) Configure() *ApiConfigureRequestBuilder
- func (m *ApiRequestBuilder) Maintenance() *ApiMaintenanceRequestBuilder
- func (m *ApiRequestBuilder) Settings() *ApiSettingsRequestBuilder
- func (m *ApiRequestBuilder) Start() *ApiStartRequestBuilder
- func (m *ApiRequestBuilder) Upgrade() *ApiUpgradeRequestBuilder
- type ApiSettingsAuthorizedKeysDeleteRequestBody
- func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) GetAdditionalData() map[string]any
- func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) GetAuthorizedKey() *string
- func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) GetFieldDeserializers() ...
- func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) Serialize(...) error
- func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) SetAdditionalData(value map[string]any)
- func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) SetAuthorizedKey(value *string)
- type ApiSettingsAuthorizedKeysDeleteRequestBodyable
- type ApiSettingsAuthorizedKeysPostRequestBody
- func (m *ApiSettingsAuthorizedKeysPostRequestBody) GetAdditionalData() map[string]any
- func (m *ApiSettingsAuthorizedKeysPostRequestBody) GetAuthorizedKey() *string
- func (m *ApiSettingsAuthorizedKeysPostRequestBody) GetFieldDeserializers() ...
- func (m *ApiSettingsAuthorizedKeysPostRequestBody) Serialize(...) error
- func (m *ApiSettingsAuthorizedKeysPostRequestBody) SetAdditionalData(value map[string]any)
- func (m *ApiSettingsAuthorizedKeysPostRequestBody) SetAuthorizedKey(value *string)
- type ApiSettingsAuthorizedKeysPostRequestBodyable
- type ApiSettingsAuthorizedKeysRequestBuilder
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) Delete(ctx context.Context, body ApiSettingsAuthorizedKeysDeleteRequestBodyable, ...) ([]ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.SshKeyable, ...)
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) Get(ctx context.Context, ...) ([]ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.SshKeyable, ...)
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) Post(ctx context.Context, body ApiSettingsAuthorizedKeysPostRequestBodyable, ...) ([]ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.SshKeyable, ...)
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) ToDeleteRequestInformation(ctx context.Context, body ApiSettingsAuthorizedKeysDeleteRequestBodyable, ...) (...)
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiSettingsAuthorizedKeysPostRequestBodyable, ...) (...)
- func (m *ApiSettingsAuthorizedKeysRequestBuilder) WithUrl(rawUrl string) *ApiSettingsAuthorizedKeysRequestBuilder
- type ApiSettingsPutRequestBody
- func (m *ApiSettingsPutRequestBody) GetAdditionalData() map[string]any
- func (m *ApiSettingsPutRequestBody) GetFieldDeserializers() ...
- func (m *ApiSettingsPutRequestBody) GetSettings() *string
- func (m *ApiSettingsPutRequestBody) Serialize(...) error
- func (m *ApiSettingsPutRequestBody) SetAdditionalData(value map[string]any)
- func (m *ApiSettingsPutRequestBody) SetSettings(value *string)
- type ApiSettingsPutRequestBodyable
- type ApiSettingsRequestBuilder
- func (m *ApiSettingsRequestBuilder) AuthorizedKeys() *ApiSettingsAuthorizedKeysRequestBuilder
- func (m *ApiSettingsRequestBuilder) Get(ctx context.Context, ...) (...)
- func (m *ApiSettingsRequestBuilder) Put(ctx context.Context, body ApiSettingsPutRequestBodyable, ...) error
- func (m *ApiSettingsRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ApiSettingsRequestBuilder) ToPutRequestInformation(ctx context.Context, body ApiSettingsPutRequestBodyable, ...) (...)
- func (m *ApiSettingsRequestBuilder) WithUrl(rawUrl string) *ApiSettingsRequestBuilder
- type ApiStartPostRequestBody
- func (m *ApiStartPostRequestBody) GetAdditionalData() map[string]any
- func (m *ApiStartPostRequestBody) GetFieldDeserializers() ...
- func (m *ApiStartPostRequestBody) GetLicense() *string
- func (m *ApiStartPostRequestBody) GetPassword() *string
- func (m *ApiStartPostRequestBody) GetSettings() *string
- func (m *ApiStartPostRequestBody) Serialize(...) error
- func (m *ApiStartPostRequestBody) SetAdditionalData(value map[string]any)
- func (m *ApiStartPostRequestBody) SetLicense(value *string)
- func (m *ApiStartPostRequestBody) SetPassword(value *string)
- func (m *ApiStartPostRequestBody) SetSettings(value *string)
- type ApiStartPostRequestBodyable
- type ApiStartRequestBuilder
- func (m *ApiStartRequestBuilder) Post(ctx context.Context, body ApiStartPostRequestBodyable, ...) error
- func (m *ApiStartRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiStartPostRequestBodyable, ...) (...)
- func (m *ApiStartRequestBuilder) WithUrl(rawUrl string) *ApiStartRequestBuilder
- type ApiUpgradePostRequestBody
- func (m *ApiUpgradePostRequestBody) GetAdditionalData() map[string]any
- func (m *ApiUpgradePostRequestBody) GetFieldDeserializers() ...
- func (m *ApiUpgradePostRequestBody) GetLicense() *string
- func (m *ApiUpgradePostRequestBody) Serialize(...) error
- func (m *ApiUpgradePostRequestBody) SetAdditionalData(value map[string]any)
- func (m *ApiUpgradePostRequestBody) SetLicense(value *string)
- type ApiUpgradePostRequestBodyable
- type ApiUpgradeRequestBuilder
- func (m *ApiUpgradeRequestBuilder) Post(ctx context.Context, body ApiUpgradePostRequestBodyable, ...) error
- func (m *ApiUpgradeRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiUpgradePostRequestBodyable, ...) (...)
- func (m *ApiUpgradeRequestBuilder) WithUrl(rawUrl string) *ApiUpgradeRequestBuilder
- type SetupRequestBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateApiMaintenancePostRequestBodyFromDiscriminatorValue ¶
func CreateApiMaintenancePostRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateApiMaintenancePostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
func CreateApiSettingsAuthorizedKeysDeleteRequestBodyFromDiscriminatorValue ¶
func CreateApiSettingsAuthorizedKeysDeleteRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateApiSettingsAuthorizedKeysDeleteRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
func CreateApiSettingsAuthorizedKeysPostRequestBodyFromDiscriminatorValue ¶
func CreateApiSettingsAuthorizedKeysPostRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateApiSettingsAuthorizedKeysPostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
func CreateApiSettingsPutRequestBodyFromDiscriminatorValue ¶
func CreateApiSettingsPutRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateApiSettingsPutRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
func CreateApiStartPostRequestBodyFromDiscriminatorValue ¶
func CreateApiStartPostRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateApiStartPostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
func CreateApiUpgradePostRequestBodyFromDiscriminatorValue ¶
func CreateApiUpgradePostRequestBodyFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateApiUpgradePostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
Types ¶
type ApiConfigcheckRequestBuilder ¶
type ApiConfigcheckRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiConfigcheckRequestBuilder builds and executes requests for operations under \setup\api\configcheck
func NewApiConfigcheckRequestBuilder ¶
func NewApiConfigcheckRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiConfigcheckRequestBuilder
NewApiConfigcheckRequestBuilder instantiates a new ApiConfigcheckRequestBuilder and sets the default values.
func NewApiConfigcheckRequestBuilderInternal ¶
func NewApiConfigcheckRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiConfigcheckRequestBuilder
NewApiConfigcheckRequestBuilderInternal instantiates a new ApiConfigcheckRequestBuilder and sets the default values.
func (*ApiConfigcheckRequestBuilder) Get ¶
func (m *ApiConfigcheckRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.ConfigurationStatusable, error)
Get this endpoint allows you to check the status of the most recent configuration process:Note that you may need to wait several seconds after you start a process before you can check its status.The different statuses are:| Status | Description || ------------- | --------------------------------- || `PENDING` | The job has not started yet || `CONFIGURING` | The job is running || `DONE` | The job has finished correctly || `FAILED` | The job has finished unexpectedly | returns a ConfigurationStatusable when successful API method documentation
func (*ApiConfigcheckRequestBuilder) ToGetRequestInformation ¶
func (m *ApiConfigcheckRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation this endpoint allows you to check the status of the most recent configuration process:Note that you may need to wait several seconds after you start a process before you can check its status.The different statuses are:| Status | Description || ------------- | --------------------------------- || `PENDING` | The job has not started yet || `CONFIGURING` | The job is running || `DONE` | The job has finished correctly || `FAILED` | The job has finished unexpectedly | returns a *RequestInformation when successful
func (*ApiConfigcheckRequestBuilder) WithUrl ¶
func (m *ApiConfigcheckRequestBuilder) WithUrl(rawUrl string) *ApiConfigcheckRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiConfigcheckRequestBuilder when successful
type ApiConfigureRequestBuilder ¶
type ApiConfigureRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiConfigureRequestBuilder builds and executes requests for operations under \setup\api\configure
func NewApiConfigureRequestBuilder ¶
func NewApiConfigureRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiConfigureRequestBuilder
NewApiConfigureRequestBuilder instantiates a new ApiConfigureRequestBuilder and sets the default values.
func NewApiConfigureRequestBuilderInternal ¶
func NewApiConfigureRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiConfigureRequestBuilder
NewApiConfigureRequestBuilderInternal instantiates a new ApiConfigureRequestBuilder and sets the default values.
func (*ApiConfigureRequestBuilder) Post ¶
func (m *ApiConfigureRequestBuilder) Post(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Post this endpoint allows you to start a configuration process at any time for your updated settings to take effect: API method documentation
func (*ApiConfigureRequestBuilder) ToPostRequestInformation ¶
func (m *ApiConfigureRequestBuilder) ToPostRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToPostRequestInformation this endpoint allows you to start a configuration process at any time for your updated settings to take effect: returns a *RequestInformation when successful
func (*ApiConfigureRequestBuilder) WithUrl ¶
func (m *ApiConfigureRequestBuilder) WithUrl(rawUrl string) *ApiConfigureRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiConfigureRequestBuilder when successful
type ApiMaintenancePostRequestBody ¶
type ApiMaintenancePostRequestBody struct {
// contains filtered or unexported fields
}
func NewApiMaintenancePostRequestBody ¶
func NewApiMaintenancePostRequestBody() *ApiMaintenancePostRequestBody
NewApiMaintenancePostRequestBody instantiates a new ApiMaintenancePostRequestBody and sets the default values.
func (*ApiMaintenancePostRequestBody) GetAdditionalData ¶
func (m *ApiMaintenancePostRequestBody) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ApiMaintenancePostRequestBody) GetFieldDeserializers ¶
func (m *ApiMaintenancePostRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ApiMaintenancePostRequestBody) GetMaintenance ¶
func (m *ApiMaintenancePostRequestBody) GetMaintenance() *string
GetMaintenance gets the maintenance property value. A JSON string with the attributes `enabled` and `when`.The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.The possible values for `when` are `now` or any date parseable by mojombo/chronic(https://github.com/mojombo/chronic). returns a *string when successful
func (*ApiMaintenancePostRequestBody) Serialize ¶
func (m *ApiMaintenancePostRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ApiMaintenancePostRequestBody) SetAdditionalData ¶
func (m *ApiMaintenancePostRequestBody) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ApiMaintenancePostRequestBody) SetMaintenance ¶
func (m *ApiMaintenancePostRequestBody) SetMaintenance(value *string)
SetMaintenance sets the maintenance property value. A JSON string with the attributes `enabled` and `when`.The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.The possible values for `when` are `now` or any date parseable by mojombo/chronic(https://github.com/mojombo/chronic).
type ApiMaintenancePostRequestBodyable ¶
type ApiMaintenancePostRequestBodyable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetMaintenance() *string SetMaintenance(value *string) }
type ApiMaintenanceRequestBuilder ¶
type ApiMaintenanceRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiMaintenanceRequestBuilder builds and executes requests for operations under \setup\api\maintenance
func NewApiMaintenanceRequestBuilder ¶
func NewApiMaintenanceRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiMaintenanceRequestBuilder
NewApiMaintenanceRequestBuilder instantiates a new ApiMaintenanceRequestBuilder and sets the default values.
func NewApiMaintenanceRequestBuilderInternal ¶
func NewApiMaintenanceRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiMaintenanceRequestBuilder
NewApiMaintenanceRequestBuilderInternal instantiates a new ApiMaintenanceRequestBuilder and sets the default values.
func (*ApiMaintenanceRequestBuilder) Get ¶
func (m *ApiMaintenanceRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.MaintenanceStatusable, error)
Get check your installation's maintenance status: returns a MaintenanceStatusable when successful API method documentation
func (*ApiMaintenanceRequestBuilder) Post ¶
func (m *ApiMaintenanceRequestBuilder) Post(ctx context.Context, body ApiMaintenancePostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.MaintenanceStatusable, error)
Post > [!NOTE]> The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). returns a MaintenanceStatusable when successful API method documentation
func (*ApiMaintenanceRequestBuilder) ToGetRequestInformation ¶
func (m *ApiMaintenanceRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation check your installation's maintenance status: returns a *RequestInformation when successful
func (*ApiMaintenanceRequestBuilder) ToPostRequestInformation ¶
func (m *ApiMaintenanceRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiMaintenancePostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToPostRequestInformation > [!NOTE]> The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). returns a *RequestInformation when successful
func (*ApiMaintenanceRequestBuilder) WithUrl ¶
func (m *ApiMaintenanceRequestBuilder) WithUrl(rawUrl string) *ApiMaintenanceRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiMaintenanceRequestBuilder when successful
type ApiRequestBuilder ¶
type ApiRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiRequestBuilder builds and executes requests for operations under \setup\api
func NewApiRequestBuilder ¶
func NewApiRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiRequestBuilder
NewApiRequestBuilder instantiates a new ApiRequestBuilder and sets the default values.
func NewApiRequestBuilderInternal ¶
func NewApiRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiRequestBuilder
NewApiRequestBuilderInternal instantiates a new ApiRequestBuilder and sets the default values.
func (*ApiRequestBuilder) Configcheck ¶
func (m *ApiRequestBuilder) Configcheck() *ApiConfigcheckRequestBuilder
Configcheck the configcheck property returns a *ApiConfigcheckRequestBuilder when successful
func (*ApiRequestBuilder) Configure ¶
func (m *ApiRequestBuilder) Configure() *ApiConfigureRequestBuilder
Configure the configure property returns a *ApiConfigureRequestBuilder when successful
func (*ApiRequestBuilder) Maintenance ¶
func (m *ApiRequestBuilder) Maintenance() *ApiMaintenanceRequestBuilder
Maintenance the maintenance property returns a *ApiMaintenanceRequestBuilder when successful
func (*ApiRequestBuilder) Settings ¶
func (m *ApiRequestBuilder) Settings() *ApiSettingsRequestBuilder
Settings the settings property returns a *ApiSettingsRequestBuilder when successful
func (*ApiRequestBuilder) Start ¶
func (m *ApiRequestBuilder) Start() *ApiStartRequestBuilder
Start the start property returns a *ApiStartRequestBuilder when successful
func (*ApiRequestBuilder) Upgrade ¶
func (m *ApiRequestBuilder) Upgrade() *ApiUpgradeRequestBuilder
Upgrade the upgrade property returns a *ApiUpgradeRequestBuilder when successful
type ApiSettingsAuthorizedKeysDeleteRequestBody ¶
type ApiSettingsAuthorizedKeysDeleteRequestBody struct {
// contains filtered or unexported fields
}
func NewApiSettingsAuthorizedKeysDeleteRequestBody ¶
func NewApiSettingsAuthorizedKeysDeleteRequestBody() *ApiSettingsAuthorizedKeysDeleteRequestBody
NewApiSettingsAuthorizedKeysDeleteRequestBody instantiates a new ApiSettingsAuthorizedKeysDeleteRequestBody and sets the default values.
func (*ApiSettingsAuthorizedKeysDeleteRequestBody) GetAdditionalData ¶
func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ApiSettingsAuthorizedKeysDeleteRequestBody) GetAuthorizedKey ¶
func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) GetAuthorizedKey() *string
GetAuthorizedKey gets the authorized_key property value. The public SSH key. returns a *string when successful
func (*ApiSettingsAuthorizedKeysDeleteRequestBody) GetFieldDeserializers ¶
func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ApiSettingsAuthorizedKeysDeleteRequestBody) Serialize ¶
func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ApiSettingsAuthorizedKeysDeleteRequestBody) SetAdditionalData ¶
func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ApiSettingsAuthorizedKeysDeleteRequestBody) SetAuthorizedKey ¶
func (m *ApiSettingsAuthorizedKeysDeleteRequestBody) SetAuthorizedKey(value *string)
SetAuthorizedKey sets the authorized_key property value. The public SSH key.
type ApiSettingsAuthorizedKeysDeleteRequestBodyable ¶
type ApiSettingsAuthorizedKeysDeleteRequestBodyable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetAuthorizedKey() *string SetAuthorizedKey(value *string) }
type ApiSettingsAuthorizedKeysPostRequestBody ¶
type ApiSettingsAuthorizedKeysPostRequestBody struct {
// contains filtered or unexported fields
}
func NewApiSettingsAuthorizedKeysPostRequestBody ¶
func NewApiSettingsAuthorizedKeysPostRequestBody() *ApiSettingsAuthorizedKeysPostRequestBody
NewApiSettingsAuthorizedKeysPostRequestBody instantiates a new ApiSettingsAuthorizedKeysPostRequestBody and sets the default values.
func (*ApiSettingsAuthorizedKeysPostRequestBody) GetAdditionalData ¶
func (m *ApiSettingsAuthorizedKeysPostRequestBody) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ApiSettingsAuthorizedKeysPostRequestBody) GetAuthorizedKey ¶
func (m *ApiSettingsAuthorizedKeysPostRequestBody) GetAuthorizedKey() *string
GetAuthorizedKey gets the authorized_key property value. The public SSH key. returns a *string when successful
func (*ApiSettingsAuthorizedKeysPostRequestBody) GetFieldDeserializers ¶
func (m *ApiSettingsAuthorizedKeysPostRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ApiSettingsAuthorizedKeysPostRequestBody) Serialize ¶
func (m *ApiSettingsAuthorizedKeysPostRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ApiSettingsAuthorizedKeysPostRequestBody) SetAdditionalData ¶
func (m *ApiSettingsAuthorizedKeysPostRequestBody) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ApiSettingsAuthorizedKeysPostRequestBody) SetAuthorizedKey ¶
func (m *ApiSettingsAuthorizedKeysPostRequestBody) SetAuthorizedKey(value *string)
SetAuthorizedKey sets the authorized_key property value. The public SSH key.
type ApiSettingsAuthorizedKeysPostRequestBodyable ¶
type ApiSettingsAuthorizedKeysPostRequestBodyable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetAuthorizedKey() *string SetAuthorizedKey(value *string) }
type ApiSettingsAuthorizedKeysRequestBuilder ¶
type ApiSettingsAuthorizedKeysRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiSettingsAuthorizedKeysRequestBuilder builds and executes requests for operations under \setup\api\settings\authorized-keys
func NewApiSettingsAuthorizedKeysRequestBuilder ¶
func NewApiSettingsAuthorizedKeysRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiSettingsAuthorizedKeysRequestBuilder
NewApiSettingsAuthorizedKeysRequestBuilder instantiates a new ApiSettingsAuthorizedKeysRequestBuilder and sets the default values.
func NewApiSettingsAuthorizedKeysRequestBuilderInternal ¶
func NewApiSettingsAuthorizedKeysRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiSettingsAuthorizedKeysRequestBuilder
NewApiSettingsAuthorizedKeysRequestBuilderInternal instantiates a new ApiSettingsAuthorizedKeysRequestBuilder and sets the default values.
func (*ApiSettingsAuthorizedKeysRequestBuilder) Delete ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) Delete(ctx context.Context, body ApiSettingsAuthorizedKeysDeleteRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) ([]ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.SshKeyable, error)
Delete **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). returns a []SshKeyable when successful API method documentation
func (*ApiSettingsAuthorizedKeysRequestBuilder) Get ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) ([]ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.SshKeyable, error)
Get get all authorized SSH keys returns a []SshKeyable when successful API method documentation
func (*ApiSettingsAuthorizedKeysRequestBuilder) Post ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) Post(ctx context.Context, body ApiSettingsAuthorizedKeysPostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) ([]ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.SshKeyable, error)
Post **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). returns a []SshKeyable when successful API method documentation
func (*ApiSettingsAuthorizedKeysRequestBuilder) ToDeleteRequestInformation ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) ToDeleteRequestInformation(ctx context.Context, body ApiSettingsAuthorizedKeysDeleteRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToDeleteRequestInformation **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). returns a *RequestInformation when successful
func (*ApiSettingsAuthorizedKeysRequestBuilder) ToGetRequestInformation ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
returns a *RequestInformation when successful
func (*ApiSettingsAuthorizedKeysRequestBuilder) ToPostRequestInformation ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiSettingsAuthorizedKeysPostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToPostRequestInformation **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). returns a *RequestInformation when successful
func (*ApiSettingsAuthorizedKeysRequestBuilder) WithUrl ¶
func (m *ApiSettingsAuthorizedKeysRequestBuilder) WithUrl(rawUrl string) *ApiSettingsAuthorizedKeysRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiSettingsAuthorizedKeysRequestBuilder when successful
type ApiSettingsPutRequestBody ¶
type ApiSettingsPutRequestBody struct {
// contains filtered or unexported fields
}
func NewApiSettingsPutRequestBody ¶
func NewApiSettingsPutRequestBody() *ApiSettingsPutRequestBody
NewApiSettingsPutRequestBody instantiates a new ApiSettingsPutRequestBody and sets the default values.
func (*ApiSettingsPutRequestBody) GetAdditionalData ¶
func (m *ApiSettingsPutRequestBody) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ApiSettingsPutRequestBody) GetFieldDeserializers ¶
func (m *ApiSettingsPutRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ApiSettingsPutRequestBody) GetSettings ¶
func (m *ApiSettingsPutRequestBody) GetSettings() *string
GetSettings gets the settings property value. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). returns a *string when successful
func (*ApiSettingsPutRequestBody) Serialize ¶
func (m *ApiSettingsPutRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ApiSettingsPutRequestBody) SetAdditionalData ¶
func (m *ApiSettingsPutRequestBody) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ApiSettingsPutRequestBody) SetSettings ¶
func (m *ApiSettingsPutRequestBody) SetSettings(value *string)
SetSettings sets the settings property value. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings).
type ApiSettingsPutRequestBodyable ¶
type ApiSettingsPutRequestBodyable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetSettings() *string SetSettings(value *string) }
type ApiSettingsRequestBuilder ¶
type ApiSettingsRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiSettingsRequestBuilder builds and executes requests for operations under \setup\api\settings
func NewApiSettingsRequestBuilder ¶
func NewApiSettingsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiSettingsRequestBuilder
NewApiSettingsRequestBuilder instantiates a new ApiSettingsRequestBuilder and sets the default values.
func NewApiSettingsRequestBuilderInternal ¶
func NewApiSettingsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiSettingsRequestBuilder
NewApiSettingsRequestBuilderInternal instantiates a new ApiSettingsRequestBuilder and sets the default values.
func (*ApiSettingsRequestBuilder) AuthorizedKeys ¶
func (m *ApiSettingsRequestBuilder) AuthorizedKeys() *ApiSettingsAuthorizedKeysRequestBuilder
AuthorizedKeys the authorizedKeys property returns a *ApiSettingsAuthorizedKeysRequestBuilder when successful
func (*ApiSettingsRequestBuilder) Get ¶
func (m *ApiSettingsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (ie1e2072a5a4eb80f74a1387d59644d3f70804e6b7b2f406016da8826571f1207.EnterpriseSettingsable, error)
Get gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings).> [!NOTE]> You cannot retrieve the management console password with the Enterprise administration API. returns a EnterpriseSettingsable when successful API method documentation
func (*ApiSettingsRequestBuilder) Put ¶
func (m *ApiSettingsRequestBuilder) Put(ctx context.Context, body ApiSettingsPutRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Put applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings).**Notes:**- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." API method documentation
func (*ApiSettingsRequestBuilder) ToGetRequestInformation ¶
func (m *ApiSettingsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings).> [!NOTE]> You cannot retrieve the management console password with the Enterprise administration API. returns a *RequestInformation when successful
func (*ApiSettingsRequestBuilder) ToPutRequestInformation ¶
func (m *ApiSettingsRequestBuilder) ToPutRequestInformation(ctx context.Context, body ApiSettingsPutRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToPutRequestInformation applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings).**Notes:**- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." returns a *RequestInformation when successful
func (*ApiSettingsRequestBuilder) WithUrl ¶
func (m *ApiSettingsRequestBuilder) WithUrl(rawUrl string) *ApiSettingsRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiSettingsRequestBuilder when successful
type ApiStartPostRequestBody ¶
type ApiStartPostRequestBody struct {
// contains filtered or unexported fields
}
func NewApiStartPostRequestBody ¶
func NewApiStartPostRequestBody() *ApiStartPostRequestBody
NewApiStartPostRequestBody instantiates a new ApiStartPostRequestBody and sets the default values.
func (*ApiStartPostRequestBody) GetAdditionalData ¶
func (m *ApiStartPostRequestBody) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ApiStartPostRequestBody) GetFieldDeserializers ¶
func (m *ApiStartPostRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ApiStartPostRequestBody) GetLicense ¶
func (m *ApiStartPostRequestBody) GetLicense() *string
GetLicense gets the license property value. The content of your _.ghl_ license file. returns a *string when successful
func (*ApiStartPostRequestBody) GetPassword ¶
func (m *ApiStartPostRequestBody) GetPassword() *string
GetPassword gets the password property value. You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. returns a *string when successful
func (*ApiStartPostRequestBody) GetSettings ¶
func (m *ApiStartPostRequestBody) GetSettings() *string
GetSettings gets the settings property value. An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). returns a *string when successful
func (*ApiStartPostRequestBody) Serialize ¶
func (m *ApiStartPostRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ApiStartPostRequestBody) SetAdditionalData ¶
func (m *ApiStartPostRequestBody) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ApiStartPostRequestBody) SetLicense ¶
func (m *ApiStartPostRequestBody) SetLicense(value *string)
SetLicense sets the license property value. The content of your _.ghl_ license file.
func (*ApiStartPostRequestBody) SetPassword ¶
func (m *ApiStartPostRequestBody) SetPassword(value *string)
SetPassword sets the password property value. You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
func (*ApiStartPostRequestBody) SetSettings ¶
func (m *ApiStartPostRequestBody) SetSettings(value *string)
SetSettings sets the settings property value. An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings).
type ApiStartPostRequestBodyable ¶
type ApiStartPostRequestBodyable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetLicense() *string GetPassword() *string GetSettings() *string SetLicense(value *string) SetPassword(value *string) SetSettings(value *string) }
type ApiStartRequestBuilder ¶
type ApiStartRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiStartRequestBuilder builds and executes requests for operations under \setup\api\start
func NewApiStartRequestBuilder ¶
func NewApiStartRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiStartRequestBuilder
NewApiStartRequestBuilder instantiates a new ApiStartRequestBuilder and sets the default values.
func NewApiStartRequestBuilderInternal ¶
func NewApiStartRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiStartRequestBuilder
NewApiStartRequestBuilderInternal instantiates a new ApiStartRequestBuilder and sets the default values.
func (*ApiStartRequestBuilder) Post ¶
func (m *ApiStartRequestBuilder) Post(ctx context.Context, body ApiStartPostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Post when you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.> [!NOTE]> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). API method documentation
func (*ApiStartRequestBuilder) ToPostRequestInformation ¶
func (m *ApiStartRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiStartPostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToPostRequestInformation when you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.> [!NOTE]> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). returns a *RequestInformation when successful
func (*ApiStartRequestBuilder) WithUrl ¶
func (m *ApiStartRequestBuilder) WithUrl(rawUrl string) *ApiStartRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiStartRequestBuilder when successful
type ApiUpgradePostRequestBody ¶
type ApiUpgradePostRequestBody struct {
// contains filtered or unexported fields
}
func NewApiUpgradePostRequestBody ¶
func NewApiUpgradePostRequestBody() *ApiUpgradePostRequestBody
NewApiUpgradePostRequestBody instantiates a new ApiUpgradePostRequestBody and sets the default values.
func (*ApiUpgradePostRequestBody) GetAdditionalData ¶
func (m *ApiUpgradePostRequestBody) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ApiUpgradePostRequestBody) GetFieldDeserializers ¶
func (m *ApiUpgradePostRequestBody) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ApiUpgradePostRequestBody) GetLicense ¶
func (m *ApiUpgradePostRequestBody) GetLicense() *string
GetLicense gets the license property value. The content of your new _.ghl_ license file. returns a *string when successful
func (*ApiUpgradePostRequestBody) Serialize ¶
func (m *ApiUpgradePostRequestBody) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ApiUpgradePostRequestBody) SetAdditionalData ¶
func (m *ApiUpgradePostRequestBody) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ApiUpgradePostRequestBody) SetLicense ¶
func (m *ApiUpgradePostRequestBody) SetLicense(value *string)
SetLicense sets the license property value. The content of your new _.ghl_ license file.
type ApiUpgradePostRequestBodyable ¶
type ApiUpgradePostRequestBodyable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetLicense() *string SetLicense(value *string) }
type ApiUpgradeRequestBuilder ¶
type ApiUpgradeRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ApiUpgradeRequestBuilder builds and executes requests for operations under \setup\api\upgrade
func NewApiUpgradeRequestBuilder ¶
func NewApiUpgradeRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiUpgradeRequestBuilder
NewApiUpgradeRequestBuilder instantiates a new ApiUpgradeRequestBuilder and sets the default values.
func NewApiUpgradeRequestBuilderInternal ¶
func NewApiUpgradeRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ApiUpgradeRequestBuilder
NewApiUpgradeRequestBuilderInternal instantiates a new ApiUpgradeRequestBuilder and sets the default values.
func (*ApiUpgradeRequestBuilder) Post ¶
func (m *ApiUpgradeRequestBuilder) Post(ctx context.Context, body ApiUpgradePostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) error
Post this API upgrades your license and also triggers the configuration process.> [!NOTE]> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). API method documentation
func (*ApiUpgradeRequestBuilder) ToPostRequestInformation ¶
func (m *ApiUpgradeRequestBuilder) ToPostRequestInformation(ctx context.Context, body ApiUpgradePostRequestBodyable, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToPostRequestInformation this API upgrades your license and also triggers the configuration process.> [!NOTE]> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). returns a *RequestInformation when successful
func (*ApiUpgradeRequestBuilder) WithUrl ¶
func (m *ApiUpgradeRequestBuilder) WithUrl(rawUrl string) *ApiUpgradeRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ApiUpgradeRequestBuilder when successful
type SetupRequestBuilder ¶
type SetupRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
SetupRequestBuilder builds and executes requests for operations under \setup
func NewSetupRequestBuilder ¶
func NewSetupRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SetupRequestBuilder
NewSetupRequestBuilder instantiates a new SetupRequestBuilder and sets the default values.
func NewSetupRequestBuilderInternal ¶
func NewSetupRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *SetupRequestBuilder
NewSetupRequestBuilderInternal instantiates a new SetupRequestBuilder and sets the default values.
func (*SetupRequestBuilder) Api ¶
func (m *SetupRequestBuilder) Api() *ApiRequestBuilder
Api the api property returns a *ApiRequestBuilder when successful
Source Files
¶
- api_configcheck_request_builder.go
- api_configure_request_builder.go
- api_maintenance_post_request_body.go
- api_maintenance_request_builder.go
- api_request_builder.go
- api_settings_authorized_keys_delete_request_body.go
- api_settings_authorized_keys_post_request_body.go
- api_settings_authorized_keys_request_builder.go
- api_settings_put_request_body.go
- api_settings_request_builder.go
- api_start_post_request_body.go
- api_start_request_builder.go
- api_upgrade_post_request_body.go
- api_upgrade_request_builder.go
- setup_request_builder.go