Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateCredentials(ctx context.Context, req CreateCredentialsRequest, opts ...call.Option) (*CreateCredentialsResponse, error)
- func (c *Client) DeleteCredentials(ctx context.Context, req DeleteCredentialsRequest, opts ...call.Option) (*DeleteCredentialsResponse, error)
- func (c *Client) GetCredentials(ctx context.Context, req GetCredentialsRequest, opts ...call.Option) (*GetCredentialsResponse, error)
- func (c *Client) ListCredentials(ctx context.Context, req ListCredentialsRequest, opts ...call.Option) (*ListCredentialsResponse, error)
- func (c *Client) UpdateCredentials(ctx context.Context, req UpdateCredentialsRequest, opts ...call.Option) (*UpdateCredentialsResponse, error)
- type CreateCredentialsRequest
- type CreateCredentialsResponse
- type Credential
- type DeleteCredentialsRequest
- type DeleteCredentialsResponse
- type GetCredentialsRequest
- type GetCredentialsResponse
- type ListCredentialsRequest
- type ListCredentialsResponse
- type UpdateCredentialsRequest
- type UpdateCredentialsResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) CreateCredentials ¶
func (c *Client) CreateCredentials(ctx context.Context, req CreateCredentialsRequest, opts ...call.Option) (*CreateCredentialsResponse, error)
Creates a Git credential entry for the user. Use the PATCH endpoint to update existing credentials, or the DELETE endpoint to delete existing credentials.
func (*Client) DeleteCredentials ¶
func (c *Client) DeleteCredentials(ctx context.Context, req DeleteCredentialsRequest, opts ...call.Option) (*DeleteCredentialsResponse, error)
Deletes the specified Git credential.
func (*Client) GetCredentials ¶
func (c *Client) GetCredentials(ctx context.Context, req GetCredentialsRequest, opts ...call.Option) (*GetCredentialsResponse, error)
Gets the Git credential with the specified credential ID.
func (*Client) ListCredentials ¶
func (c *Client) ListCredentials(ctx context.Context, req ListCredentialsRequest, opts ...call.Option) (*ListCredentialsResponse, error)
Lists the calling user's Git credentials.
func (*Client) UpdateCredentials ¶
func (c *Client) UpdateCredentials(ctx context.Context, req UpdateCredentialsRequest, opts ...call.Option) (*UpdateCredentialsResponse, error)
Updates the specified Git credential.
type CreateCredentialsRequest ¶
type CreateCredentialsRequest struct {
// Git provider. This field is case-insensitive. The available Git providers are
// `gitHub`, `bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps
// Services, including Microsoft Entra ID authentication), `gitHubEnterprise`,
// `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab
// Self-Managed), and `awsCodeCommit`.
GitProvider *string
// The username provided with your Git provider account and associated with the
// credential. For most Git providers it is only used to set the Git committer &
// author names for commits, however it may be required for authentication
// depending on your Git provider / token requirements. Required for AWS
// CodeCommit.
GitUsername *string
// The personal access token used to authenticate to the corresponding Git
// provider. For certain providers, support may exist for other types of scoped
// access tokens. [Learn more].
//
// [Learn more]: https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html
PersonalAccessToken *string
// The ID of the service principal whose credentials will be modified. Only
// service principal managers can perform this action.
PrincipalId *int64
// the name of the git credential, used for identification and ease of lookup
Name *string
// if the credential is the default for the given provider
IsDefaultForProvider *bool
// The authenticating email associated with your Git provider user account. Used
// for authentication with the remote repository and also sets the author &
// committer identity for commits. Required for most Git providers except AWS
// CodeCommit. Learn more at
// https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider
GitEmail *string
}
type CreateCredentialsResponse ¶
type CreateCredentialsResponse struct {
// ID of the credential object in the workspace.
CredentialId *int64
// The Git provider associated with the credential.
GitProvider *string
// The username provided with your Git provider account and associated with the
// credential. For most Git providers it is only used to set the Git committer &
// author names for commits, however it may be required for authentication
// depending on your Git provider / token requirements. Required for AWS
// CodeCommit.
GitUsername *string
// the name of the git credential, used for identification and ease of lookup
Name *string
// if the credential is the default for the given provider
IsDefaultForProvider *bool
// The authenticating email associated with your Git provider user account. Used
// for authentication with the remote repository and also sets the author &
// committer identity for commits. Required for most Git providers except AWS
// CodeCommit. Learn more at
// https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider
GitEmail *string
}
type Credential ¶
type Credential struct {
// ID of the credential object in the workspace.
CredentialId *int64
// The Git provider associated with the credential. One of `gitHub`,
// `bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services,
// including Microsoft Entra ID authentication), `gitHubEnterprise`,
// `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab
// Self-Managed), or `awsCodeCommit`.
GitProvider *string
// The username provided with your Git provider account and associated with the
// credential. For most Git providers it is only used to set the Git committer &
// author names for commits, however it may be required for authentication
// depending on your Git provider / token requirements. Required for AWS
// CodeCommit.
GitUsername *string
// the name of the git credential, used for identification and ease of lookup
Name *string
// if the credential is the default for the given provider
IsDefaultForProvider *bool
// The authenticating email associated with your Git provider user account. Used
// for authentication with the remote repository and also sets the author &
// committer identity for commits. Required for most Git providers except AWS
// CodeCommit. Learn more at
// https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider
GitEmail *string
}
type DeleteCredentialsResponse ¶
type DeleteCredentialsResponse struct {
}
type GetCredentialsRequest ¶
type GetCredentialsResponse ¶
type GetCredentialsResponse struct {
// ID of the credential object in the workspace.
CredentialId *int64
// The Git provider associated with the credential.
GitProvider *string
// The username provided with your Git provider account and associated with the
// credential. For most Git providers it is only used to set the Git committer &
// author names for commits, however it may be required for authentication
// depending on your Git provider / token requirements. Required for AWS
// CodeCommit.
GitUsername *string
// the name of the git credential, used for identification and ease of lookup
Name *string
// if the credential is the default for the given provider
IsDefaultForProvider *bool
// The authenticating email associated with your Git provider user account. Used
// for authentication with the remote repository and also sets the author &
// committer identity for commits. Required for most Git providers except AWS
// CodeCommit. Learn more at
// https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider
GitEmail *string
}
type ListCredentialsRequest ¶
type ListCredentialsRequest struct {
// The ID of the service principal whose credentials will be listed. Only
// service principal managers can perform this action.
PrincipalId *int64
}
type ListCredentialsResponse ¶
type ListCredentialsResponse struct {
// List of credentials.
Credentials []Credential
}
type UpdateCredentialsRequest ¶
type UpdateCredentialsRequest struct {
// The ID for the corresponding credential to access.
Id *int64
// The personal access token used to authenticate to the corresponding Git
// provider. For certain providers, support may exist for other types of scoped
// access tokens. [Learn more].
//
// [Learn more]: https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html
PersonalAccessToken *string
// Git provider. This field is case-insensitive. The available Git providers are
// `gitHub`, `bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps
// Services, including Microsoft Entra ID authentication), `gitHubEnterprise`,
// `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab
// Self-Managed), and `awsCodeCommit`.
GitProvider *string
// The username provided with your Git provider account and associated with the
// credential. For most Git providers it is only used to set the Git committer &
// author names for commits, however it may be required for authentication
// depending on your Git provider / token requirements. Required for AWS
// CodeCommit.
GitUsername *string
// The ID of the service principal whose credentials will be modified. Only
// service principal managers can perform this action.
PrincipalId *int64
// the name of the git credential, used for identification and ease of lookup
Name *string
// if the credential is the default for the given provider
IsDefaultForProvider *bool
// The authenticating email associated with your Git provider user account. Used
// for authentication with the remote repository and also sets the author &
// committer identity for commits. Required for most Git providers except AWS
// CodeCommit. Learn more at
// https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider
GitEmail *string
}
type UpdateCredentialsResponse ¶
type UpdateCredentialsResponse struct {
}
Click to show internal directories.
Click to hide internal directories.