From 507ea5914d2b246821a400a6aa7d6ccca47904fa Mon Sep 17 00:00:00 2001 From: Mike Date: Mon, 15 Apr 2024 18:13:57 +0000 Subject: [PATCH] Deployed 03db2ab to 3.7.0 with MkDocs 1.3.0 and mike 2.1.0.dev0 --- 3.7.0/404.html | 8 +-- 3.7.0/CONTRIBUTING/index.html | 8 +-- 3.7.0/generated/api/connection/index.html | 42 +++++++------- 3.7.0/generated/api/datasets/index.html | 24 ++++---- 3.7.0/generated/api/environment/index.html | 20 +++---- 3.7.0/generated/api/executions/index.html | 50 ++++++++-------- 3.7.0/generated/api/flink_cluster/index.html | 50 ++++++++-------- 3.7.0/generated/api/git_provider/index.html | 22 +++---- 3.7.0/generated/api/git_remote/index.html | 22 +++---- 3.7.0/generated/api/git_repo/index.html | 58 +++++++++---------- 3.7.0/generated/api/jobs/index.html | 46 +++++++-------- 3.7.0/generated/api/kafka_schema/index.html | 28 ++++----- 3.7.0/generated/api/kafka_topic/index.html | 28 ++++----- 3.7.0/generated/api/login/index.html | 16 ++--- 3.7.0/generated/api/opensearch/index.html | 14 ++--- 3.7.0/generated/api/projects/index.html | 46 +++++++-------- 3.7.0/generated/api/secrets/index.html | 32 +++++----- 3.7.0/index.html | 8 +-- 3.7.0/js/inject-api-links.js | 9 ++- 3.7.0/overrides/partials/tabs-item.html | 8 +-- 3.7.0/sitemap.xml | 34 +++++------ 3.7.0/sitemap.xml.gz | Bin 372 -> 372 bytes versions.json | 4 +- 23 files changed, 291 insertions(+), 286 deletions(-) diff --git a/3.7.0/404.html b/3.7.0/404.html index 5d9e934f6..b5cb30d42 100644 --- a/3.7.0/404.html +++ b/3.7.0/404.html @@ -474,10 +474,10 @@ diff --git a/3.7.0/CONTRIBUTING/index.html b/3.7.0/CONTRIBUTING/index.html index 79173fff0..b0ff63dfc 100644 --- a/3.7.0/CONTRIBUTING/index.html +++ b/3.7.0/CONTRIBUTING/index.html @@ -483,10 +483,10 @@ diff --git a/3.7.0/generated/api/connection/index.html b/3.7.0/generated/api/connection/index.html index 541b68df8..9c6b2c9a5 100644 --- a/3.7.0/generated/api/connection/index.html +++ b/3.7.0/generated/api/connection/index.html @@ -483,10 +483,10 @@ @@ -1431,7 +1431,7 @@

Connection API#

Creation#

-

[source]

+

[source]

connection#

Connection.connection(
     host=None,
@@ -1447,32 +1447,32 @@ 

connectionProperties#

-

[source]

+

[source]

api_key_file#


-

[source]

+

[source]

api_key_value#


-

[source]

+

[source]

cert_folder#


-

[source]

+

[source]

host#


-

[source]

+

[source]

hostname_verification#


-

[source]

+

[source]

port#


-

[source]

+

[source]

project#


-

[source]

+

[source]

trust_store_path#


Methods#

-

[source]

+

[source]

close#

Connection.close()
 
@@ -1481,7 +1481,7 @@

close# external environments such as AWS SageMaker.

Usage is recommended but optional.


-

[source]

+

[source]

connect#

Connection.connect()
 
@@ -1501,7 +1501,7 @@

connect[source]

+

[source]

connection#

Connection.connection(
     host=None,
@@ -1516,7 +1516,7 @@ 

connection

Connection factory method, accessible through hopsworks.connection().


-

[source]

+

[source]

create_project#

Connection.create_project(name, description=None, feature_store_topic=None)
 
@@ -1537,7 +1537,7 @@

create_project[source]

+

[source]

get_project#

Connection.get_project(name=None)
 
@@ -1549,7 +1549,7 @@

get_projectReturns

Project. A project handle object to perform operations on.


-

[source]

+

[source]

get_projects#

Connection.get_projects()
 
@@ -1557,7 +1557,7 @@

get_projectsReturns

List[Project]: List of Project objects


-

[source]

+

[source]

get_secrets_api#

Connection.get_secrets_api()
 
@@ -1565,7 +1565,7 @@

get_secrets_api[source]

+

[source]

project_exists#

Connection.project_exists(name)
 
diff --git a/3.7.0/generated/api/datasets/index.html b/3.7.0/generated/api/datasets/index.html index 83a6eeb5f..c30ee6451 100644 --- a/3.7.0/generated/api/datasets/index.html +++ b/3.7.0/generated/api/datasets/index.html @@ -483,10 +483,10 @@ @@ -1279,7 +1279,7 @@

Datasets API#

Handle#

-

[source]

+

[source]

get_dataset_api#

Project.get_dataset_api()
 
@@ -1288,7 +1288,7 @@

get_dataset_apiMethods#

-

[source]

+

[source]

copy#

DatasetApi.copy(source_path, destination_path, overwrite=False)
 
@@ -1312,7 +1312,7 @@

copy#RestAPIError: If unable to perform the copy
-

[source]

+

[source]

download#

DatasetApi.download(path, local_path=None, overwrite=False)
 
@@ -1338,7 +1338,7 @@

download[source]

+

[source]

exists#

DatasetApi.exists(path)
 
@@ -1354,7 +1354,7 @@

exists[source]

+

[source]

mkdir#

DatasetApi.mkdir(path)
 
@@ -1378,7 +1378,7 @@

mkdir#
  • RestAPIError: If unable to create the directory

  • -

    [source]

    +

    [source]

    move#

    DatasetApi.move(source_path, destination_path, overwrite=False)
     
    @@ -1402,7 +1402,7 @@

    move#RestAPIError: If unable to perform the move
    -

    [source]

    +

    [source]

    remove#

    DatasetApi.remove(path)
     
    @@ -1416,7 +1416,7 @@

    remove[source]

    +

    [source]

    upload#

    DatasetApi.upload(
         local_path,
    diff --git a/3.7.0/generated/api/environment/index.html b/3.7.0/generated/api/environment/index.html
    index 49aba06ba..67642d4fb 100644
    --- a/3.7.0/generated/api/environment/index.html
    +++ b/3.7.0/generated/api/environment/index.html
    @@ -483,10 +483,10 @@
     
     
     
    @@ -1303,7 +1303,7 @@
     
     

    Environment API#

    Handle#

    -

    [source]

    +

    [source]

    get_environment_api#

    Project.get_environment_api()
     
    @@ -1312,7 +1312,7 @@

    get_environment_apiCreation#

    -

    [source]

    +

    [source]

    create_environment#

    EnvironmentApi.create_environment(await_creation=True)
     
    @@ -1337,7 +1337,7 @@

    create_environmentRetrieval#

    -

    [source]

    +

    [source]

    get_environment#

    EnvironmentApi.get_environment()
     
    @@ -1358,7 +1358,7 @@

    get_environmentMethods#

    -

    [source]

    +

    [source]

    delete#

    Environment.delete()
     
    @@ -1370,7 +1370,7 @@

    delete[source]

    +

    [source]

    install_requirements#

    Environment.install_requirements(path, await_installation=True)
     
    @@ -1394,7 +1394,7 @@

    install_requirements[source]

    +

    [source]

    install_wheel#

    Environment.install_wheel(path, await_installation=True)
     
    diff --git a/3.7.0/generated/api/executions/index.html b/3.7.0/generated/api/executions/index.html index 852797b58..980685b54 100644 --- a/3.7.0/generated/api/executions/index.html +++ b/3.7.0/generated/api/executions/index.html @@ -483,10 +483,10 @@ @@ -1513,7 +1513,7 @@

    Executions API#

    Creation#

    -

    [source]

    +

    [source]

    run#

    Job.run(args=None, await_termination=False)
     
    @@ -1537,7 +1537,7 @@

    run#Execution. The execution object for the submitted run.


    Retrieval#

    -

    [source]

    +

    [source]

    get_executions#

    Job.get_executions()
     
    @@ -1548,70 +1548,70 @@

    get_executionsProperties#

    -

    [source]

    +

    [source]

    app_id#

    Application id for the execution


    -

    [source]

    +

    [source]

    args#

    Arguments set for the execution.


    -

    [source]

    +

    [source]

    duration#

    Duration in milliseconds the execution ran.


    -

    [source]

    +

    [source]

    final_status#

    Final status of the execution. Can be UNDEFINED, SUCCEEDED, FAILED or KILLED.


    -

    [source]

    +

    [source]

    hdfs_user#

    Filesystem user for the execution.


    -

    [source]

    +

    [source]

    id#

    Id of the execution


    -

    [source]

    +

    [source]

    job_name#

    Name of the job the execution belongs to


    -

    [source]

    +

    [source]

    job_type#

    Type of the job the execution belongs to


    -

    [source]

    +

    [source]

    progress#

    Progress of the execution.


    -

    [source]

    +

    [source]

    state#

    Current state of the execution.


    -

    [source]

    +

    [source]

    stderr_path#

    Path in Hopsworks Filesystem to stderr log file


    -

    [source]

    +

    [source]

    stdout_path#

    Path in Hopsworks Filesystem to stdout log file


    -

    [source]

    +

    [source]

    submission_time#

    Timestamp when the execution was submitted


    -

    [source]

    +

    [source]

    success#

    Boolean to indicate if execution ran successfully or failed

    Returns

    bool. True if execution ran successfully. False if execution failed or was killed.


    -

    [source]

    +

    [source]

    user#

    User that submitted the execution.


    Methods#

    -

    [source]

    +

    [source]

    await_termination#

    Execution.await_termination()
     
    @@ -1619,7 +1619,7 @@

    await_termination[source]

    +

    [source]

    delete#

    Execution.delete()
     
    @@ -1631,7 +1631,7 @@

    delete[source]

    +

    [source]

    download_logs#

    Execution.download_logs(path=None)
     
    @@ -1654,7 +1654,7 @@

    download_logsstr. Path to downloaded log for stdout. str. Path to downloaded log for stderr.


    -

    [source]

    +

    [source]

    get_url#

    Execution.get_url()
     
    diff --git a/3.7.0/generated/api/flink_cluster/index.html b/3.7.0/generated/api/flink_cluster/index.html index 98d012095..b371c72df 100644 --- a/3.7.0/generated/api/flink_cluster/index.html +++ b/3.7.0/generated/api/flink_cluster/index.html @@ -483,10 +483,10 @@ @@ -1591,7 +1591,7 @@

    FlinkCluster API#

    Handle#

    -

    [source]

    +

    [source]

    Project.get_flink_cluster_api()
     
    @@ -1600,7 +1600,7 @@ -

    [source]

    +

    [source]

    setup_cluster#

    FlinkClusterApi.setup_cluster(name, config=None)
     
    @@ -1630,7 +1630,7 @@

    setup_cluster

    Get the cluster#

    -

    [source]

    +

    [source]

    get_cluster#

    FlinkClusterApi.get_cluster(name)
     
    @@ -1655,7 +1655,7 @@

    get_cluster

    Start the cluster#

    -

    [source]

    +

    [source]

    start#

    FlinkCluster.start(await_time=1800)
     
    @@ -1680,7 +1680,7 @@

    start#

    Submit job to cluster#

    -

    [source]

    +

    [source]

    submit_job#

    FlinkCluster.submit_job(jar_id, main_class, job_arguments=None)
     
    @@ -1718,32 +1718,32 @@

    submit_jobProperties#

    -

    [source]

    +

    [source]

    config#

    Configuration for the cluster


    -

    [source]

    +

    [source]

    creation_time#

    Date of creation for the cluster


    -

    [source]

    +

    [source]

    creator#

    Creator of the cluster


    -

    [source]

    +

    [source]

    id#

    Id of the cluster


    -

    [source]

    +

    [source]

    name#

    Name of the cluster


    -

    [source]

    +

    [source]

    state#

    State of the cluster


    Methods#

    -

    [source]

    +

    [source]

    get_jars#

    FlinkCluster.get_jars()
     
    @@ -1766,7 +1766,7 @@

    get_jars[source]

    +

    [source]

    get_job#

    FlinkCluster.get_job(job_id)
     
    @@ -1794,7 +1794,7 @@

    get_job[source]

    +

    [source]

    get_jobs#

    FlinkCluster.get_jobs()
     
    @@ -1817,12 +1817,12 @@

    get_jobs[source]

    +

    [source]

    get_url#

    FlinkCluster.get_url()
     

    -

    [source]

    +

    [source]

    job_state#

    FlinkCluster.job_state(job_id)
     
    @@ -1851,7 +1851,7 @@

    job_state[source]

    +

    [source]

    start#

    FlinkCluster.start(await_time=1800)
     
    @@ -1875,7 +1875,7 @@

    start[source]

    +

    [source]

    stop#

    FlinkCluster.stop()
     
    @@ -1896,7 +1896,7 @@

    stop#RestAPIError: If unable to stop the flink cluster.
    -

    [source]

    +

    [source]

    stop_job#

    FlinkCluster.stop_job(job_id)
     
    @@ -1922,7 +1922,7 @@

    stop_job[source]

    +

    [source]

    submit_job#

    FlinkCluster.submit_job(jar_id, main_class, job_arguments=None)
     
    @@ -1959,7 +1959,7 @@

    submit_jobRestAPIError: If unable to submit the job.
    -

    [source]

    +

    [source]

    upload_jar#

    FlinkCluster.upload_jar(jar_file)
     
    diff --git a/3.7.0/generated/api/git_provider/index.html b/3.7.0/generated/api/git_provider/index.html index a4ca3f960..78b10bb79 100644 --- a/3.7.0/generated/api/git_provider/index.html +++ b/3.7.0/generated/api/git_provider/index.html @@ -483,10 +483,10 @@ @@ -1343,7 +1343,7 @@

    GitProvider API#

    Handle#

    -

    [source]

    +

    [source]

    get_git_api#

    Project.get_git_api()
     
    @@ -1352,7 +1352,7 @@

    get_git_apiGitApi: The Git Api handle


    Creation#

    -

    [source]

    +

    [source]

    set_provider#

    GitApi.set_provider(provider, username, token)
     
    @@ -1377,7 +1377,7 @@

    set_provider

    Retrieval#

    -

    [source]

    +

    [source]

    get_provider#

    GitApi.get_provider(provider)
     
    @@ -1393,7 +1393,7 @@

    get_providerRestAPIError: If unable to get the git provider
    -

    [source]

    +

    [source]

    get_providers#

    GitApi.get_providers()
     
    @@ -1406,16 +1406,16 @@

    get_providers

    Properties#

    -

    [source]

    +

    [source]

    git_provider#

    Name of the provider, can be GitHub, GitLab or BitBucket


    -

    [source]

    +

    [source]

    username#

    Username set for the provider


    Methods#

    -

    [source]

    +

    [source]

    delete#

    GitProvider.delete()
     
    diff --git a/3.7.0/generated/api/git_remote/index.html b/3.7.0/generated/api/git_remote/index.html index a4f46789f..c9decdf46 100644 --- a/3.7.0/generated/api/git_remote/index.html +++ b/3.7.0/generated/api/git_remote/index.html @@ -483,10 +483,10 @@ @@ -1343,7 +1343,7 @@

    GitRemote API#

    Handle#

    -

    [source]

    +

    [source]

    get_git_api#

    Project.get_git_api()
     
    @@ -1352,7 +1352,7 @@

    get_git_apiGitApi: The Git Api handle


    Creation#

    -

    [source]

    +

    [source]

    add_remote#

    GitRepo.add_remote(name, url)
     
    @@ -1378,7 +1378,7 @@

    add_remoteRetrieval#

    -

    [source]

    +

    [source]

    get_remote#

    GitRepo.get_remote(name)
     
    @@ -1392,7 +1392,7 @@

    get_remote[source]

    +

    [source]

    get_remotes#

    GitRepo.get_remotes()
     
    @@ -1403,16 +1403,16 @@

    get_remotesRestAPIError in case the backend fails to retrieve the remotes.


    Properties#

    -

    [source]

    +

    [source]

    name#

    Name of the remote


    -

    [source]

    +

    [source]

    url#

    Url of the remote


    Methods#

    -

    [source]

    +

    [source]

    delete#

    GitRemote.delete()
     
    diff --git a/3.7.0/generated/api/git_repo/index.html b/3.7.0/generated/api/git_repo/index.html index 85b56edaa..a380098ae 100644 --- a/3.7.0/generated/api/git_repo/index.html +++ b/3.7.0/generated/api/git_repo/index.html @@ -483,10 +483,10 @@ @@ -1595,7 +1595,7 @@

    GitRepo API#

    Handle#

    -

    [source]

    +

    [source]

    get_git_api#

    Project.get_git_api()
     
    @@ -1604,7 +1604,7 @@

    get_git_apiGitApi: The Git Api handle


    Creation#

    -

    [source]

    +

    [source]

    clone#

    GitApi.clone(url, path, provider=None, branch=None)
     
    @@ -1632,7 +1632,7 @@

    clone#

    Retrieval#

    -

    [source]

    +

    [source]

    get_repo#

    GitApi.get_repo(name, path=None)
     
    @@ -1649,7 +1649,7 @@

    get_repo[source]

    +

    [source]

    get_repos#

    GitApi.get_repos()
     
    @@ -1662,40 +1662,40 @@

    get_reposProperties#

    -

    [source]

    +

    [source]

    creator#

    Creator of the git repo


    -

    [source]

    +

    [source]

    current_branch#

    The current branch for the git repo


    -

    [source]

    +

    [source]

    current_commit#

    The current commit for the git repo


    -

    [source]

    +

    [source]

    id#

    Id of the git repo


    -

    [source]

    +

    [source]

    name#

    Name of the git repo


    -

    [source]

    +

    [source]

    path#

    Path to the git repo in the Hopsworks Filesystem


    -

    [source]

    +

    [source]

    provider#

    Git provider for the repo, can be GitHub, GitLab or BitBucket


    -

    [source]

    +

    [source]

    read_only#

    If True then the repository functions GitRepo.commit, GitRepo.push and GitRepo.checkout_files are forbidden.


    Methods#

    -

    [source]

    +

    [source]

    add_remote#

    GitRepo.add_remote(name, url)
     
    @@ -1720,7 +1720,7 @@

    add_remote[source]

    +

    [source]

    checkout_branch#

    GitRepo.checkout_branch(branch, create=False)
     
    @@ -1733,7 +1733,7 @@

    checkout_branch[source]

    +

    [source]

    checkout_commit#

    GitRepo.checkout_commit(commit)
     
    @@ -1745,7 +1745,7 @@

    checkout_commit[source]

    +

    [source]

    checkout_files#

    GitRepo.checkout_files(files)
     
    @@ -1757,7 +1757,7 @@

    checkout_files[source]

    +

    [source]

    commit#

    GitRepo.commit(message, all=True, files=None)
     
    @@ -1771,7 +1771,7 @@

    commit[source]

    +

    [source]

    delete#

    GitRepo.delete()
     
    @@ -1783,7 +1783,7 @@

    delete[source]

    +

    [source]

    delete_branch#

    GitRepo.delete_branch(branch)
     
    @@ -1795,7 +1795,7 @@

    delete_branchRaises

    RestAPIError in case the backend fails to delete the branch.


    -

    [source]

    +

    [source]

    get_commits#

    GitRepo.get_commits(branch)
     
    @@ -1809,7 +1809,7 @@

    get_commitsRaises

    RestAPIError in case the backend fails to retrieve the commits.


    -

    [source]

    +

    [source]

    get_remote#

    GitRepo.get_remote(name)
     
    @@ -1823,7 +1823,7 @@

    get_remote[source]

    +

    [source]

    get_remotes#

    GitRepo.get_remotes()
     
    @@ -1833,7 +1833,7 @@

    get_remotesRaises

    RestAPIError in case the backend fails to retrieve the remotes.


    -

    [source]

    +

    [source]

    pull#

    GitRepo.pull(branch, remote="origin")
     
    @@ -1846,7 +1846,7 @@

    pull#Raises

    RestAPIError in case the backend fails to retrieve the commits.


    -

    [source]

    +

    [source]

    push#

    GitRepo.push(branch, remote="origin")
     
    @@ -1859,7 +1859,7 @@

    push#Raises

    RestAPIError in case the backend fails to retrieve the commits.


    -

    [source]

    +

    [source]

    status#

    GitRepo.status()
     
    diff --git a/3.7.0/generated/api/jobs/index.html b/3.7.0/generated/api/jobs/index.html index 76740553a..beff23276 100644 --- a/3.7.0/generated/api/jobs/index.html +++ b/3.7.0/generated/api/jobs/index.html @@ -483,10 +483,10 @@ @@ -1537,7 +1537,7 @@

    Jobs API#

    Handle#

    -

    [source]

    +

    [source]

    get_jobs_api#

    Project.get_jobs_api()
     
    @@ -1546,7 +1546,7 @@

    get_jobs_apiJobsApi: The Jobs Api handle


    Configuration#

    -

    [source]

    +

    [source]

    get_configuration#

    JobsApi.get_configuration(type)
     
    @@ -1563,7 +1563,7 @@

    get_configurationCreation#

    -

    [source]

    +

    [source]

    create_job#

    JobsApi.create_job(name, config)
     
    @@ -1593,7 +1593,7 @@

    create_jobRetrieval#

    -

    [source]

    +

    [source]

    get_job#

    JobsApi.get_job(name)
     
    @@ -1609,7 +1609,7 @@

    get_job[source]

    +

    [source]

    get_jobs#

    JobsApi.get_jobs()
     
    @@ -1622,36 +1622,36 @@

    get_jobsProperties#

    -

    [source]

    +

    [source]

    config#

    Configuration for the job


    -

    [source]

    +

    [source]

    creation_time#

    Date of creation for the job


    -

    [source]

    +

    [source]

    creator#

    Creator of the job


    -

    [source]

    +

    [source]

    id#

    Id of the job


    -

    [source]

    +

    [source]

    job_schedule#

    Return the Job schedule


    -

    [source]

    +

    [source]

    job_type#

    Type of the job


    -

    [source]

    +

    [source]

    name#

    Name of the job


    Methods#

    -

    [source]

    +

    [source]

    delete#

    Job.delete()
     
    @@ -1663,7 +1663,7 @@

    delete[source]

    +

    [source]

    get_executions#

    Job.get_executions()
     
    @@ -1673,12 +1673,12 @@

    get_executions[source]

    +

    [source]

    get_url#

    Job.get_url()
     

    -

    [source]

    +

    [source]

    run#

    Job.run(args=None, await_termination=False)
     
    @@ -1701,7 +1701,7 @@

    run#Returns

    Execution. The execution object for the submitted run.


    -

    [source]

    +

    [source]

    save#

    Job.save()
     
    @@ -1713,7 +1713,7 @@

    save#Returns

    Job. The updated job object.


    -

    [source]

    +

    [source]

    schedule#

    Job.schedule(cron_expression, start_time=None, end_time=None)
     
    @@ -1737,7 +1737,7 @@

    schedule[source]

    +

    [source]

    unschedule#

    Job.unschedule()
     
    diff --git a/3.7.0/generated/api/kafka_schema/index.html b/3.7.0/generated/api/kafka_schema/index.html index 69905472d..590cb0284 100644 --- a/3.7.0/generated/api/kafka_schema/index.html +++ b/3.7.0/generated/api/kafka_schema/index.html @@ -483,10 +483,10 @@ @@ -1385,7 +1385,7 @@

    KafkaSchema API#

    Handle#

    -

    [source]

    +

    [source]

    get_kafka_api#

    Project.get_kafka_api()
     
    @@ -1394,7 +1394,7 @@

    get_kafka_apiKafkaApi: The Kafka Api handle


    Creation#

    -

    [source]

    +

    [source]

    create_schema#

    KafkaApi.create_schema(subject, schema)
     
    @@ -1435,7 +1435,7 @@

    create_schema

    Retrieval#

    -

    [source]

    +

    [source]

    get_schema#

    KafkaApi.get_schema(subject, version)
     
    @@ -1452,7 +1452,7 @@

    get_schema[source]

    +

    [source]

    get_schemas#

    KafkaApi.get_schemas(subject)
     
    @@ -1468,7 +1468,7 @@

    get_schemasRestAPIError: If unable to get the schemas
    -

    [source]

    +

    [source]

    get_subjects#

    KafkaApi.get_subjects()
     
    @@ -1481,24 +1481,24 @@

    get_subjects

    Properties#

    -

    [source]

    +

    [source]

    id#

    Id of the kafka schema


    -

    [source]

    +

    [source]

    schema#

    Schema definition


    -

    [source]

    +

    [source]

    subject#

    Name of the subject for the schema


    -

    [source]

    +

    [source]

    version#

    Version of the schema


    Methods#

    -

    [source]

    +

    [source]

    delete#

    KafkaSchema.delete()
     
    diff --git a/3.7.0/generated/api/kafka_topic/index.html b/3.7.0/generated/api/kafka_topic/index.html index 08fccdafd..d4df277a5 100644 --- a/3.7.0/generated/api/kafka_topic/index.html +++ b/3.7.0/generated/api/kafka_topic/index.html @@ -483,10 +483,10 @@ @@ -1411,7 +1411,7 @@

    KafkaTopic API#

    Handle#

    -

    [source]

    +

    [source]

    get_kafka_api#

    Project.get_kafka_api()
     
    @@ -1420,7 +1420,7 @@

    get_kafka_apiKafkaApi: The Kafka Api handle


    Configuration#

    -

    [source]

    +

    [source]

    get_default_config#

    KafkaApi.get_default_config()
     
    @@ -1445,7 +1445,7 @@

    get_default_configCreation#

    -

    [source]

    +

    [source]

    create_topic#

    KafkaApi.create_topic(name, schema, schema_version, replicas=1, partitions=1)
     
    @@ -1474,7 +1474,7 @@

    create_topic

    Retrieval#

    -

    [source]

    +

    [source]

    get_topic#

    KafkaApi.get_topic(name)
     
    @@ -1490,7 +1490,7 @@

    get_topic[source]

    +

    [source]

    get_topics#

    KafkaApi.get_topics()
     
    @@ -1503,24 +1503,24 @@

    get_topicsProperties#

    -

    [source]

    +

    [source]

    name#

    Name of the topic


    -

    [source]

    +

    [source]

    partitions#

    Number of partitions for the topic


    -

    [source]

    +

    [source]

    replicas#

    Replication factor for the topic


    -

    [source]

    +

    [source]

    schema#

    Schema for the topic


    Methods#

    -

    [source]

    +

    [source]

    delete#

    KafkaTopic.delete()
     
    diff --git a/3.7.0/generated/api/login/index.html b/3.7.0/generated/api/login/index.html index 8ec7b4028..80f3fb43c 100644 --- a/3.7.0/generated/api/login/index.html +++ b/3.7.0/generated/api/login/index.html @@ -483,10 +483,10 @@ @@ -1248,7 +1248,7 @@

    Login API#

    -

    [source]

    +

    [source]

    login#

    hopsworks.login(host=None, port=443, project=None, api_key_value=None, api_key_file=None)
     
    @@ -1280,7 +1280,7 @@

    login#

    Feature Store API#

    -

    [source]

    +

    [source]

    get_feature_store#

    Project.get_feature_store(name=None)
     
    @@ -1295,7 +1295,7 @@

    get_feature_storeModel Registry API#

    -

    [source]

    +

    [source]

    get_model_registry#

    Project.get_model_registry()
     
    @@ -1308,7 +1308,7 @@

    get_model_registryModel Serving API#

    -

    [source]

    +

    [source]

    get_model_serving#

    Project.get_model_serving()
     
    diff --git a/3.7.0/generated/api/opensearch/index.html b/3.7.0/generated/api/opensearch/index.html index e6a3b0a5c..496eb8dff 100644 --- a/3.7.0/generated/api/opensearch/index.html +++ b/3.7.0/generated/api/opensearch/index.html @@ -483,10 +483,10 @@ @@ -1209,7 +1209,7 @@

    OpenSearch API#

    Handle#

    -

    [source]

    +

    [source]

    get_opensearch_api#

    Project.get_opensearch_api()
     
    @@ -1218,7 +1218,7 @@

    get_opensearch_apiMethods#

    -

    [source]

    +

    [source]

    get_default_py_config#

    OpenSearchApi.get_default_py_config()
     
    @@ -1235,7 +1235,7 @@

    get_default_py_config[source]

    +

    [source]

    get_project_index#

    OpenSearchApi.get_project_index(index)
     
    diff --git a/3.7.0/generated/api/projects/index.html b/3.7.0/generated/api/projects/index.html index 49169db27..e6f68a10a 100644 --- a/3.7.0/generated/api/projects/index.html +++ b/3.7.0/generated/api/projects/index.html @@ -483,10 +483,10 @@ @@ -1485,7 +1485,7 @@

    Projects API#

    Creation#

    -

    [source]

    +

    [source]

    create_project#

    Connection.create_project(name, description=None, feature_store_topic=None)
     
    @@ -1507,7 +1507,7 @@

    create_projectRetrieval#

    -

    [source]

    +

    [source]

    get_project#

    Connection.get_project(name=None)
     
    @@ -1519,7 +1519,7 @@

    get_projectReturns

    Project. A project handle object to perform operations on.


    -

    [source]

    +

    [source]

    get_projects#

    Connection.get_projects()
     
    @@ -1528,28 +1528,28 @@

    get_projectsList[Project]: List of Project objects


    Properties#

    -

    [source]

    +

    [source]

    created#

    Timestamp when the project was created


    -

    [source]

    +

    [source]

    description#

    Description of the project


    -

    [source]

    +

    [source]

    id#

    Id of the project


    -

    [source]

    +

    [source]

    name#

    Name of the project


    -

    [source]

    +

    [source]

    owner#

    Owner of the project


    Methods#

    -

    [source]

    +

    [source]

    get_dataset_api#

    Project.get_dataset_api()
     
    @@ -1557,7 +1557,7 @@

    get_dataset_api[source]

    +

    [source]

    get_environment_api#

    Project.get_environment_api()
     
    @@ -1565,7 +1565,7 @@

    get_environment_api[source]

    +

    [source]

    get_feature_store#

    Project.get_feature_store(name=None)
     
    @@ -1579,7 +1579,7 @@

    get_feature_store[source]

    +

    [source]

    Project.get_flink_cluster_api()
     
    @@ -1587,7 +1587,7 @@

    get_git_api#

    Project.get_git_api()
     
    @@ -1595,7 +1595,7 @@

    get_git_apiReturns

    GitApi: The Git Api handle


    -

    [source]

    +

    [source]

    get_jobs_api#

    Project.get_jobs_api()
     
    @@ -1603,7 +1603,7 @@

    get_jobs_apiReturns

    JobsApi: The Jobs Api handle


    -

    [source]

    +

    [source]

    get_kafka_api#

    Project.get_kafka_api()
     
    @@ -1611,7 +1611,7 @@

    get_kafka_apiReturns

    KafkaApi: The Kafka Api handle


    -

    [source]

    +

    [source]

    get_model_registry#

    Project.get_model_registry()
     
    @@ -1623,7 +1623,7 @@

    get_model_registry[source]

    +

    [source]

    get_model_serving#

    Project.get_model_serving()
     
    @@ -1635,7 +1635,7 @@

    get_model_serving[source]

    +

    [source]

    get_opensearch_api#

    Project.get_opensearch_api()
     
    @@ -1643,7 +1643,7 @@

    get_opensearch_api[source]

    +

    [source]

    get_url#

    Project.get_url()
     
    diff --git a/3.7.0/generated/api/secrets/index.html b/3.7.0/generated/api/secrets/index.html index d3b5ef8c5..15f7e313e 100644 --- a/3.7.0/generated/api/secrets/index.html +++ b/3.7.0/generated/api/secrets/index.html @@ -483,10 +483,10 @@ @@ -1413,7 +1413,7 @@

    Secrets API#

    Handle#

    -

    [source]

    +

    [source]

    get_secrets_api#

    Connection.get_secrets_api()
     
    @@ -1422,7 +1422,7 @@

    get_secrets_apiCreation#

    -

    [source]

    +

    [source]

    create_secret#

    SecretsApi.create_secret(name, value, project=None)
     
    @@ -1449,7 +1449,7 @@

    create_secret

    Retrieval#

    -

    [source]

    +

    [source]

    get_secret#

    SecretsApi.get_secret(name, owner=None)
     
    @@ -1466,7 +1466,7 @@

    get_secret[source]

    +

    [source]

    get_secrets#

    SecretsApi.get_secrets()
     
    @@ -1479,32 +1479,32 @@

    get_secrets

    Properties#

    -

    [source]

    +

    [source]

    created#

    Date when secret was created


    -

    [source]

    +

    [source]

    name#

    Name of the secret


    -

    [source]

    +

    [source]

    owner#

    Owner of the secret


    -

    [source]

    +

    [source]

    scope#

    Scope of the secret


    -

    [source]

    +

    [source]

    value#

    Value of the secret


    -

    [source]

    +

    [source]

    visibility#

    Visibility of the secret


    Methods#

    -

    [source]

    +

    [source]

    delete#

    Secret.delete()
     
    @@ -1516,7 +1516,7 @@

    delete[source]

    +

    [source]

    get_url#

    Secret.get_url()
     
    diff --git a/3.7.0/index.html b/3.7.0/index.html index 394c00907..01ab385d6 100644 --- a/3.7.0/index.html +++ b/3.7.0/index.html @@ -481,10 +481,10 @@ diff --git a/3.7.0/js/inject-api-links.js b/3.7.0/js/inject-api-links.js index c49eb2b93..f54926fdc 100644 --- a/3.7.0/js/inject-api-links.js +++ b/3.7.0/js/inject-api-links.js @@ -1,14 +1,19 @@ window.addEventListener("DOMContentLoaded", function () { var windowPathNameSplits = window.location.pathname.split("/"); var majorVersionRegex = new RegExp("(\\d+[.]\\d+)") + var latestRegex = new RegExp("latest") if (majorVersionRegex.test(windowPathNameSplits[1])) { // On landing page docs.hopsworks.api/3.0 - URL contains major version // Version API dropdown document.getElementById("hopsworks_api_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + windowPathNameSplits[1] + "/generated/api/login/"; document.getElementById("hsfs_api_link").href = "https://docs.hopsworks.ai/feature-store-api/" + windowPathNameSplits[1] + "/generated/api/connection_api/"; document.getElementById("hsml_api_link").href = "https://docs.hopsworks.ai/machine-learning-api/" + windowPathNameSplits[1] + "/generated/connection_api/"; } else { // on docs.hopsworks.api/feature-store-api/3.0 / docs.hopsworks.api/hopsworks-api/3.0 / docs.hopsworks.api/machine-learning-api/3.0 - var apiVersion = windowPathNameSplits[2]; - var majorVersion = apiVersion.match(majorVersionRegex)[0]; + if (latestRegex.test(windowPathNameSplits[1]) || latestRegex.test(windowPathNameSplits[2])) { + majorVersion = "latest"; + } else { + var apiVersion = windowPathNameSplits[2]; + var majorVersion = apiVersion.match(majorVersionRegex)[0]; + } // Version main navigation document.getElementsByClassName("md-tabs__link")[0].href = "https://docs.hopsworks.ai/" + majorVersion; document.getElementsByClassName("md-tabs__link")[1].href = "https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/quickstart.ipynb"; diff --git a/3.7.0/overrides/partials/tabs-item.html b/3.7.0/overrides/partials/tabs-item.html index 2df2ced8b..9a967527f 100644 --- a/3.7.0/overrides/partials/tabs-item.html +++ b/3.7.0/overrides/partials/tabs-item.html @@ -38,10 +38,10 @@ {% elif title == "API" %} diff --git a/3.7.0/sitemap.xml b/3.7.0/sitemap.xml index 65fdac7a7..8b9625c01 100644 --- a/3.7.0/sitemap.xml +++ b/3.7.0/sitemap.xml @@ -2,87 +2,87 @@ https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/CONTRIBUTING/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/connection/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/datasets/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/environment/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/executions/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/flink_cluster/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/git_provider/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/git_remote/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/git_repo/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/jobs/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/kafka_schema/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/kafka_topic/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/login/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/opensearch/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/projects/ - 2024-04-11 + 2024-04-15 daily https://docs.hopsworks.ai/hopsworks-api/latest/3.7.0/generated/api/secrets/ - 2024-04-11 + 2024-04-15 daily \ No newline at end of file diff --git a/3.7.0/sitemap.xml.gz b/3.7.0/sitemap.xml.gz index c016b376ce436cc3535a630f937d043c811d2e00..29a218f2271d3a3566c764f9d312369dfdd327af 100644 GIT binary patch literal 372 zcmV-)0gL`0iwFp1ZXIR<|8r?{Wo=<_E_iKh0Ns|&YQr!L$M1cLkbCU3>(~cr3L9+n z(!prY#dFlejbnM1`?0s5)0WZ)7z5WATe2+l!!rIC(?h3|9XL{GCh3snX#z%KrA$3Z zmy5UTF`br!V(T=4PeQPvN!oaCpE=*}_l%T>PFP~-YEH5V2Jy3#=j_>N!r{1h)1hr)EpXX6}JpQ3x+^A*+h*I{)$Zyg>gS`0_pxm S5gw-?KFeQmQi1Vw4FCXZ7PPbg literal 372 zcmV-)0gL`0iwFp5C>Uk}|8r?{Wo=<_E_iKh0Ns|~Yr-%P$KU-cO5dAQC+r8c!Uh|@ zI2igYS$ejyX)en}>;C(tQ^Y@D3}RlAyIhX@kPG=1^JAxz12|G>X6cyaX#z%KrA$3b z*Q?j;A)S|_V(&D8PeQPvS=xASpE&RPo{{p<2}=xJ%}F-FAbxi8oIR%HC<$Xoa9aJ2 zLZd8)EELjID2X*_sYllm6N+DqOjyOW@Iap5v3r*Df)7WpGYRq?R^=q0OtXBNjmIJ6 z?7Iq+jW9KA9ekCQQ2M*zSDsUe{8HneRr~V3TzxE_*Q>?yEwa*UFyMlt;=`6iV?g@Q zBvE5j!i&(y6g32xgK}s(Fg|XMBgp;GQgL6$Rx8tPq~4PU7d1(({Kh&wsOknl9CYa6 z1~4o}4Y9+|xZigxwyoHlq|FV0c(h7J&7rYYamx_2U