Go API client for polarismgmt

Defines the management APIs for using Polaris to create and manage Iceberg catalogs and their principals

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.0.1
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import polarismgmt "github.com/tower/polaris-management-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value polarismgmt.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), polarismgmt.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value polarismgmt.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), polarismgmt.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using polarismgmt.ContextOperationServerIndices and polarismgmt.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), polarismgmt.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), polarismgmt.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://localhost/api/management/v1

Class	Method	HTTP request	Description
DefaultAPI	AddGrantToCatalogRole	Put /catalogs/{catalogName}/catalog-roles/{catalogRoleName}/grants
DefaultAPI	AssignCatalogRoleToPrincipalRole	Put /principal-roles/{principalRoleName}/catalog-roles/{catalogName}
DefaultAPI	AssignPrincipalRole	Put /principals/{principalName}/principal-roles
DefaultAPI	CreateCatalog	Post /catalogs
DefaultAPI	CreateCatalogRole	Post /catalogs/{catalogName}/catalog-roles
DefaultAPI	CreatePrincipal	Post /principals
DefaultAPI	CreatePrincipalRole	Post /principal-roles
DefaultAPI	DeleteCatalog	Delete /catalogs/{catalogName}
DefaultAPI	DeleteCatalogRole	Delete /catalogs/{catalogName}/catalog-roles/{catalogRoleName}
DefaultAPI	DeletePrincipal	Delete /principals/{principalName}
DefaultAPI	DeletePrincipalRole	Delete /principal-roles/{principalRoleName}
DefaultAPI	GetCatalog	Get /catalogs/{catalogName}
DefaultAPI	GetCatalogRole	Get /catalogs/{catalogName}/catalog-roles/{catalogRoleName}
DefaultAPI	GetPrincipal	Get /principals/{principalName}
DefaultAPI	GetPrincipalRole	Get /principal-roles/{principalRoleName}
DefaultAPI	ListAssigneePrincipalRolesForCatalogRole	Get /catalogs/{catalogName}/catalog-roles/{catalogRoleName}/principal-roles
DefaultAPI	ListAssigneePrincipalsForPrincipalRole	Get /principal-roles/{principalRoleName}/principals
DefaultAPI	ListCatalogRoles	Get /catalogs/{catalogName}/catalog-roles
DefaultAPI	ListCatalogRolesForPrincipalRole	Get /principal-roles/{principalRoleName}/catalog-roles/{catalogName}
DefaultAPI	ListCatalogs	Get /catalogs
DefaultAPI	ListGrantsForCatalogRole	Get /catalogs/{catalogName}/catalog-roles/{catalogRoleName}/grants
DefaultAPI	ListPrincipalRoles	Get /principal-roles
DefaultAPI	ListPrincipalRolesAssigned	Get /principals/{principalName}/principal-roles
DefaultAPI	ListPrincipals	Get /principals
DefaultAPI	ResetCredentials	Post /principals/{principalName}/reset
DefaultAPI	RevokeCatalogRoleFromPrincipalRole	Delete /principal-roles/{principalRoleName}/catalog-roles/{catalogName}/{catalogRoleName}
DefaultAPI	RevokeGrantFromCatalogRole	Post /catalogs/{catalogName}/catalog-roles/{catalogRoleName}/grants
DefaultAPI	RevokePrincipalRole	Delete /principals/{principalName}/principal-roles/{principalRoleName}
DefaultAPI	RotateCredentials	Post /principals/{principalName}/rotate
DefaultAPI	UpdateCatalog	Put /catalogs/{catalogName}
DefaultAPI	UpdateCatalogRole	Put /catalogs/{catalogName}/catalog-roles/{catalogRoleName}
DefaultAPI	UpdatePrincipal	Put /principals/{principalName}
DefaultAPI	UpdatePrincipalRole	Put /principal-roles/{principalRoleName}

Documentation For Models

• AddGrantRequest
• AuthenticationParameters
• AwsIamServiceIdentityInfo
• AwsStorageConfigInfo
• AzureStorageConfigInfo
• BearerAuthenticationParameters
• Catalog
• CatalogGrant
• CatalogPrivilege
• CatalogProperties
• CatalogRole
• CatalogRoles
• Catalogs
• ConnectionConfigInfo
• CreateCatalogRequest
• CreateCatalogRoleRequest
• CreatePrincipalRequest
• CreatePrincipalRoleRequest
• ExternalCatalog
• FileStorageConfigInfo
• GcpStorageConfigInfo
• GrantCatalogRoleRequest
• GrantPrincipalRoleRequest
• GrantResource
• GrantResources
• HadoopConnectionConfigInfo
• HiveConnectionConfigInfo
• IcebergRestConnectionConfigInfo
• ImplicitAuthenticationParameters
• NamespaceGrant
• NamespacePrivilege
• OAuthClientCredentialsParameters
• PolarisCatalog
• PolicyGrant
• PolicyPrivilege
• Principal
• PrincipalRole
• PrincipalRoles
• PrincipalWithCredentials
• PrincipalWithCredentialsCredentials
• Principals
• ResetPrincipalRequest
• RevokeGrantRequest
• ServiceIdentityInfo
• SigV4AuthenticationParameters
• StorageConfigInfo
• TableGrant
• TablePrivilege
• UpdateCatalogRequest
• UpdateCatalogRoleRequest
• UpdatePrincipalRequest
• UpdatePrincipalRoleRequest
• ViewGrant
• ViewPrivilege

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

• Type: OAuth
• Flow: implicit
• Authorization URL: {scheme}://{host}/api/v1/oauth/tokens
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), polarismgmt.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, polarismgmt.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author