Skip to main content

Module clients.sandbox.port.port

Functions​

port_from_api_object ​

def port_from_api_object(api_object: h2o_engine_manager.gen.model.v1_port.V1Port) ‑> Port

Convert V1Port API object to Port.

Args​
api_object
The V1Port API object to convert.
Returns​
Port
The Port object.

port_to_api_object ​

def port_to_api_object(port: Port) ‑> h2o_engine_manager.gen.model.v1_port.V1Port

Convert Port to V1Port API object.

Args​
port
The Port object to convert.
Returns​
V1Port
The API object ready to be sent to the server.

Classes​

Port​

class Port(name: str = '', display_name: str = '', public: bool = False, internal_url: str = '', public_url: str = '', create_time: Optional[datetime.datetime] = None, creator: str = '', creator_display_name: str = '', update_time: Optional[datetime.datetime] = None, updater: str = '', updater_display_name: str = '', state: h2o_engine_manager.clients.sandbox.port.state.PortState = PortState.STATE_UNSPECIFIED, failure_reason: str = '')

Port represents a network port exposed from a SandboxEngine.

Port represents a network port exposed from a SandboxEngine.

Args​
name
The resource name of the port. Format: "workspaces//sandboxEngines//ports/*"
display_name
Optional human-readable display name for this port.
public
Whether this port should be publicly accessible. If False, the port is only accessible within the cluster.
internal_url
Output only. URL for accessing this port from within the Kubernetes cluster.
public_url
Output only. URL for accessing this port from outside the cluster. Only set when public is True.
create_time
Output only. Time when this port was created.
creator
Output only. Name of an entity that created this port.
creator_display_name
Output only. Display name of the entity that created this port.
update_time
Output only. Time when this port was last updated.
updater
Output only. Name of an entity that last updated this port.
updater_display_name
Output only. Display name of the entity that last updated this port.
state
Output only. The current state of the port.
failure_reason
Output only. Failure reason during port creation. Only set when state is STATE_FAILED.
Feedback