Skip to main content

Module clients.h2o_engine_version.client

Classes

H2OEngineVersionClient

class H2OEngineVersionClient(connection_config: h2o_engine_manager.clients.connection_config.ConnectionConfig, verify_ssl: bool = True, ssl_ca_cert: Optional[str] = None)

H2OEngineVersionClient manages H2OEngineVersions.

Initializes H2OEngineVersionClient.

Args
connection_config : ConnectionConfig
AIEM connection configuration object.
verify_ssl
Set to False to disable SSL certificate verification.
ssl_ca_cert
Path to a CA cert bundle with certificates of trusted CAs.

Methods

apply_h2o_engine_version_configs

def apply_h2o_engine_version_configs(self, configs: List[h2o_engine_manager.clients.h2o_engine_version.h2o_engine_version_config.H2OEngineVersionConfig], parent: str = 'workspaces/global') ‑> List[h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion]

Set all H2OEngineVersions to a state defined in the configs in the specified parent workspace. H2OEngineVersions that are not specified in the configs will be deleted in the specified parent workspace. H2OEngineVersions that are specified in the configs will be recreated with the new values in the specified parent workspace.

Args
configs
H2OEngineVersion configurations that should be applied.
parent
Workspace name in which to apply configs. Format is workspaces/*.

Returns: applied H2OEngineVersions

assign_h2o_engine_version_aliases

def assign_h2o_engine_version_aliases(self, name: str, aliases: Optional[List[str]] = None) ‑> List[h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion]

Assign new set of resourceID aliases to H2OEngineVersion. This will replace existing H2OEngineVersion resourceID aliases with the new aliases. If there are other H2OEngineVersions with the same alias that we try to assign to this H2OEngineVersion, they will be deleted from the other H2OEngineVersions.

Example 1 - two versions in the same workspace: - h2ow1v1(name="workspaces/w1/h2oEngineVersions/v1", aliases=["latest", "bar"]) - h2ow1v2(name="workspaces/w1/h2oEngineVersions/v2", aliases=["baz", "foo"]) - AssignAliases(h2ow1v1, aliases=["latest", "baz"]) => h2ow1v1.aliases=["latest", "baz"] (changed) => h2ow1v2.aliases=["foo"] (changed)

Example 2 - two versions in different workspaces: - h2ow1v1(name="workspaces/w1/h2oEngineVersions/v1", aliases=["latest", "bar"]) - h2ow2v1(name="workspaces/w2/h2oEngineVersions/v1", aliases=["latest", "baz"]) - AssignAliases(h2ow1v1, aliases=["latest", "baz"]) => h2ow1v1.aliases=["latest", "baz"] (changed) => h2ow2v1.aliases=["latest", "baz"] (unchanged)

Args
name
H2OEngineVersion resource name. Format is workspaces/*/h2oEngineVersions/*.
aliases
New resourceID aliases of the H2OEngineVersion.

Returns: all H2OEngineVersions from the same workspace.

create_h2o_engine_version

def create_h2o_engine_version(self, parent: str, h2o_engine_version: h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion, h2o_engine_version_id: str) ‑> h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion

Standard Create method.

Args
parent : str
Name of the version's parent workspace. Format: workspaces/*.
h2o_engine_version : H2OEngineVersion
H2OEngineVersion to create.
h2o_engine_version_id : str
Specify the H2OEngineVersion ID, which will become a part of the H2OEngineVersion resource name. It must: - be in semver format (more segments than three segments allowed) - contain max 63 characters Examples: "1.10.3", "1.10.3-alpha", "1.10.3.2", "1.10.3.2-alpha"
Returns
H2OEngineVersion
created H2OEngineVersion.

delete_all_h2o_engine_versions

def delete_all_h2o_engine_versions(self, parent: str) ‑> None

Help method for deleting all H2OEngineVersions in a specified parent workspace.

Args
parent : str
Parent workspace name. Format is workspaces/*.

delete_h2o_engine_version

def delete_h2o_engine_version(self, name: str) ‑> None

Standard Delete method.

Args
name : str
Name of the H2OEngineVersion to delete. Format is workspaces/*/h2oEngineVersions/*

get_h2o_engine_version

def get_h2o_engine_version(self, name: str) ‑> h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion

Standard Get method.

Args
name
Name of the H2OEngineVersion to retrieve. Format: workspaces/*/h2oEngineVersions/*

list_all_h2o_engine_versions

def list_all_h2o_engine_versions(self, parent: str) ‑> List[h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion]

Help method for listing all H2OEngineVersions.

Args
parent : str
Name of the workspace from which to list versions. Format: workspaces/*.

list_h2o_engine_versions

def list_h2o_engine_versions(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.h2o_engine_version.page.H2OEngineVersionsPage

Standard list method.

Args
parent : str
Name of the workspace from which to list versions. Format: workspaces/*.
page_size : int
Maximum number of H2OEngineVersions to return in a response. If unspecified (or set to 0), at most 50 H2OEngineVersions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token : str
Page token. Leave unset to receive the initial page. To list any subsequent pages use the value of 'next_page_token' returned from the H2OEngineVersionsPage.
Returns
H2OEngineVersionsPage
H2OEngineVersionsPage object.

update_h2o_engine_version

def update_h2o_engine_version(self, h2o_engine_version: h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion, update_mask: str = '*') ‑> h2o_engine_manager.clients.h2o_engine_version.version.H2OEngineVersion

Standard Update method.

Args
h2o_engine_version : H2OEngineVersion
version to update.
update_mask : str
The field mask to use for the update. Allowed field paths are: - deprecated - image - image_pull_policy - image_pull_secrets Default value "*" will update all updatable fields.
Returns
H2OEngineVersion
Updated H2OEngineVersion.

Feedback