SDK Referenceair_sdk

air_sdk.const

View as Markdown

Constants shared throughout the SDK.

Attributes

Classes

NameDescription
HTTPHeadersKnown HTTP headers.
TopologyFormatTopology format types.

Functions

NameDescription
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

DEFAULT_CONNECT_TIMEOUT = timedelta(...)
 
DEFAULT_READ_TIMEOUT = timedelta(...)
 
DEFAULT_PAGINATION_PAGE_SIZE = 200
 
DEFAULT_RETRY_ATTEMPTS: int = 5
 
DEFAULT_RETRY_BACKOFF_FACTOR: float = 1.0
 
DEFAULT_RETRY_BACKOFF_JITTER: float = 1.0
 
MULTIPART_CHUNK_SIZE
 
MULTIPART_MIN_PART_SIZE
 
MAX_RECOMMENDED_UPLOAD_WORKERS = 10
 
DEFAULT_UPLOAD_TIMEOUT = timedelta(...)
 
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
SCOPED_KEY_PREFIX = nvapi-
 
AIR_API_URL = https://api.air-ngc.nvidia.com/
 
NGC_API_PROD_URL = https://api.ngc.nvidia.com
 
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.