Skip to main content

Module clients.ide_engine_profile.client

Classes​

IDEEngineProfileClient​

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

IDEEngineProfileClient manages IDEEngineProfiles.

Initializes IDEEngineProfileClient.

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​

copy_ide_engine_profile ​

def copy_ide_engine_profile(self, name: str, parent: str, ide_engine_profile_id: str) ‑> h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile

Copies an existing IDEEngineProfile to a new IDEEngineProfile.

Args​
name : str
Source IDEEngineProfile resource name. Format: workspaces/*/ideEngineProfiles/*
parent : str
The parent workspace where the new IDEEngineProfile will be created. Format: workspaces/*. Only workspaces/global is allowed.
ide_engine_profile_id : str
The ID to use for the new IDEEngineProfile, which will form the profile's resource name. This value must: • contain 1-63 characters • contain only lowercase alphanumeric characters or hyphen ('-') • start with an alphabetic character • end with an alphanumeric character
Returns​
IDEEngineProfile
created IDEEngineProfile.

create_ide_engine_profile ​

def create_ide_engine_profile(self, parent: str, ide_engine_profile: h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile, ide_engine_profile_id: str) ‑> h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile

Standard Create method.

Args​
parent : str
Name of the profile's parent workspace. Format: workspaces/*. Only workspaces/global is allowed.
ide_engine_profile : IDEEngineProfile
IDEEngineProfile to create.
ide_engine_profile_id : str
The ID to use for the IDEEngineProfile, which will form the profile's resource name. This value must: • contain 1-63 characters • contain only lowercase alphanumeric characters or hyphen ('-') • start with an alphabetic character • end with an alphanumeric character
Returns​
IDEEngineProfile
created IDEEngineProfile.

delete_ide_engine_profile ​

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

Standard Delete method.

Args​
name : str
Name of the IDEEngineProfile to delete. Format is workspaces/*/ideEngineProfiles/*

get_ide_engine_profile ​

def get_ide_engine_profile(self, name: str) ‑> h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile

Standard Get method.

Args​
name
Name of the IDEEngineProfile to retrieve. Format: workspaces/*/ideEngineProfiles/*

list_all_assigned_ide_engine_profiles ​

def list_all_assigned_ide_engine_profiles(self, parent: str) ‑> List[h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile]

Help method for listing all assigned IDEEngineProfiles.

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

list_all_ide_engine_profiles ​

def list_all_ide_engine_profiles(self, parent: str) ‑> List[h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile]

Help method for listing all IDEEngineProfiles.

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

list_assigned_ide_engine_profiles ​

def list_assigned_ide_engine_profiles(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.ide_engine_profile.page.IDEEngineProfilesPage

Returns assigned IDEEngineProfiles that match OIDC roles of the caller.

Args​
parent : str
Name of the workspace from which to list profiles. Format: workspaces/*.
page_size : int
Maximum number of IDEEngineProfiles to return in a response. If unspecified (or set to 0), at most 50 IDEEngineProfiles 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 IDEEngineProfilesPage.
Returns​
IDEEngineProfilesPage
IDEEngineProfilesPage object.

list_ide_engine_profiles ​

def list_ide_engine_profiles(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.ide_engine_profile.page.IDEEngineProfilesPage

Standard list method.

Args​
parent : str
Name of the workspace from which to list profiles. Format: workspaces/*.
page_size : int
Maximum number of IDEEngineProfiles to return in a response. If unspecified (or set to 0), at most 50 IDEEngineProfiles 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 IDEEngineProfilesPage.
Returns​
IDEEngineProfilesPage
IDEEngineProfilesPage object.

update_ide_engine_profile ​

def update_ide_engine_profile(self, ide_engine_profile: h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile, update_mask: str = '*') ‑> h2o_engine_manager.clients.ide_engine_profile.profile.IDEEngineProfile

Standard Update method.

Args​
ide_engine_profile : IDEEngineProfile
profile to update.
update_mask : str

The field mask to use for the update. Allowed field paths are: • display_name • priority • enabled • assigned_oidc_roles_enabled • assigned_oidc_roles • max_running_engines • cpu_constraint • gpu_constraint • memory_bytes_constraint • storage_bytes_constraint • max_idle_duration_constraint • max_running_duration_constraint • yaml_pod_template_spec • yaml_gpu_tolerations • storage_class_name • gpu_resource_name

Default value "*" will update all updatable fields.

Returns​
IDEEngineProfile
Updated IDEEngineProfile.

Feedback