air_sdk.const

Constants shared throughout the SDK.

Attributes

SDK_ROOT
MAX_STACKLEVEL
DEFAULT_CONNECT_TIMEOUT
DEFAULT_READ_TIMEOUT
DEFAULT_PAGINATION_PAGE_SIZE
DEFAULT_RETRY_ATTEMPTS
DEFAULT_RETRY_BACKOFF_FACTOR
DEFAULT_RETRY_BACKOFF_JITTER
MULTIPART_CHUNK_SIZE
MULTIPART_MIN_PART_SIZE
MAX_RECOMMENDED_UPLOAD_WORKERS
DEFAULT_UPLOAD_TIMEOUT
SCOPED_KEY_PREFIX
AIR_API_URL
NGC_API_PROD_URL
NGC_API_STG_URL

Classes

HTTPHeaders	Known HTTP headers.
TopologyFormat	Topology format types.

Functions

get_ngc_api_base_url(→ urllib.parse.ParseResult)	Return the NGC API base URL based on the Air API URL.
get_ngc_device_login_url(→ urllib.parse.ParseResult)	Return the NGC device login URL.
get_ngc_token_url(→ urllib.parse.ParseResult)	Return the NGC token URL.
get_ngc_sak_details_url(→ urllib.parse.ParseResult)	Return the NGC SAK details URL.
get_ngc_me_url(→ urllib.parse.ParseResult)	Return the NGC user info URL.

Module Contents

air_sdk.const.SDK_ROOT

air_sdk.const.MAX_STACKLEVEL = 20

air_sdk.const.DEFAULT_CONNECT_TIMEOUT

air_sdk.const.DEFAULT_READ_TIMEOUT

air_sdk.const.DEFAULT_PAGINATION_PAGE_SIZE = 200

air_sdk.const.DEFAULT_RETRY_ATTEMPTS: int = 5

air_sdk.const.DEFAULT_RETRY_BACKOFF_FACTOR: float = 1.0

air_sdk.const.DEFAULT_RETRY_BACKOFF_JITTER: float = 1.0

air_sdk.const.MULTIPART_CHUNK_SIZE = 100000000

air_sdk.const.MULTIPART_MIN_PART_SIZE = 5242880

air_sdk.const.MAX_RECOMMENDED_UPLOAD_WORKERS = 10

air_sdk.const.DEFAULT_UPLOAD_TIMEOUT

class air_sdk.const.HTTPHeaders

Bases: str, enum.Enum

Known HTTP headers.

CONTENT_TYPE = 'Content-Type'

AUTHORIZATION = 'Authorization'

USER_AGENT = 'User-Agent'

AIR_SDK_SYS_VERSION = 'X-Air-Sdk-Sys-Version'

AIR_SDK_VERSION = 'X-Air-Sdk-Version'

AIR_SDK_TIMEZONE = 'X-Air-Sdk-Timezone'

AIR_SDK_PLATFORM = 'X-Air-Sdk-Platform'

class air_sdk.const.TopologyFormat

Bases: str, enum.Enum

Topology format types.

JSON = 'JSON'

DOT = 'DOT'

air_sdk.const.SCOPED_KEY_PREFIX = 'nvapi-'

air_sdk.const.AIR_API_URL = 'https://api.air-ngc.nvidia.com/'

air_sdk.const.NGC_API_PROD_URL = 'https://api.ngc.nvidia.com'

air_sdk.const.NGC_API_STG_URL = 'https://api.stg.ngc.nvidia.com'

air_sdk.const.get_ngc_api_base_url(api_url: str) → urllib.parse.ParseResult

Return the NGC API base URL based on the Air API URL.

If the api_url contains ‘stg’, the staging NGC URL is used. Otherwise, the production NGC URL is used.

air_sdk.const.get_ngc_device_login_url(api_url: str) → urllib.parse.ParseResult

Return the NGC device login URL.

air_sdk.const.get_ngc_token_url(api_url: str) → urllib.parse.ParseResult

Return the NGC token URL.

air_sdk.const.get_ngc_sak_details_url(api_url: str) → urllib.parse.ParseResult

Return the NGC SAK details URL.

air_sdk.const.get_ngc_me_url(api_url: str) → urllib.parse.ParseResult

Return the NGC user info URL.