setup

package
v0.0.5-GHES.3.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateApiMaintenancePostRequestBodyFromDiscriminatorValue

CreateApiMaintenancePostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateApiSettingsAuthorizedKeysDeleteRequestBodyFromDiscriminatorValue

CreateApiSettingsAuthorizedKeysDeleteRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateApiSettingsAuthorizedKeysPostRequestBodyFromDiscriminatorValue

CreateApiSettingsAuthorizedKeysPostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateApiSettingsPutRequestBodyFromDiscriminatorValue

CreateApiSettingsPutRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateApiStartPostRequestBodyFromDiscriminatorValue

CreateApiStartPostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateApiUpgradePostRequestBodyFromDiscriminatorValue

CreateApiUpgradePostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

Types

type ApiConfigcheckRequestBuilder

ApiConfigcheckRequestBuilder builds and executes requests for operations under \setup\api\configcheck

func NewApiConfigcheckRequestBuilder

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

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

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

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

ApiConfigureRequestBuilder builds and executes requests for operations under \setup\api\configure

func NewApiConfigureRequestBuilder

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

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

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

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

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

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 ApiMaintenanceRequestBuilder

ApiMaintenanceRequestBuilder builds and executes requests for operations under \setup\api\maintenance

func NewApiMaintenanceRequestBuilder

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) Post

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

ToGetRequestInformation check your installation's maintenance status: returns a *RequestInformation when successful

func (*ApiMaintenanceRequestBuilder) ToPostRequestInformation

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

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

ApiRequestBuilder builds and executes requests for operations under \setup\api

func NewApiRequestBuilder

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

Configcheck the configcheck property returns a *ApiConfigcheckRequestBuilder when successful

func (*ApiRequestBuilder) Configure

Configure the configure property returns a *ApiConfigureRequestBuilder when successful

func (*ApiRequestBuilder) Maintenance

Maintenance the maintenance property returns a *ApiMaintenanceRequestBuilder when successful

func (*ApiRequestBuilder) Settings

Settings the settings property returns a *ApiSettingsRequestBuilder when successful

func (*ApiRequestBuilder) Start

Start the start property returns a *ApiStartRequestBuilder when successful

func (*ApiRequestBuilder) Upgrade

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

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*ApiSettingsAuthorizedKeysDeleteRequestBody) Serialize

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 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

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*ApiSettingsAuthorizedKeysPostRequestBody) Serialize

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 ApiSettingsAuthorizedKeysRequestBuilder

type ApiSettingsAuthorizedKeysRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

ApiSettingsAuthorizedKeysRequestBuilder builds and executes requests for operations under \setup\api\settings\authorized-keys

func NewApiSettingsAuthorizedKeysRequestBuilder

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

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) Post

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

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) ToPostRequestInformation

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

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

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

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 ApiSettingsRequestBuilder

ApiSettingsRequestBuilder builds and executes requests for operations under \setup\api\settings

func NewApiSettingsRequestBuilder

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

AuthorizedKeys the authorizedKeys property returns a *ApiSettingsAuthorizedKeysRequestBuilder when successful

func (*ApiSettingsRequestBuilder) Get

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

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

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

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

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

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

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

ApiStartRequestBuilder builds and executes requests for operations under \setup\api\start

func NewApiStartRequestBuilder

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

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

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

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

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

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 ApiUpgradeRequestBuilder

ApiUpgradeRequestBuilder builds and executes requests for operations under \setup\api\upgrade

func NewApiUpgradeRequestBuilder

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

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

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

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

SetupRequestBuilder builds and executes requests for operations under \setup

func NewSetupRequestBuilder

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

Api the api property returns a *ApiRequestBuilder when successful

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL