Class HostStartRequest

java.lang.Object
com.github.copilot.generated.rpc.HostStartRequest
@CopilotExperimental @Generated("copilot-sdk-codegen") public final class HostStartRequest extends Object
Starts a supervised AHP host with at least one explicitly selected transport.

Required inputs are constructor arguments. Optional inputs have fluent setters.

Since:
1.0.0

  • Constructor Details

    • HostStartRequest

      public HostStartRequest(String hostId)
      Creates a request with its required inputs.
      Parameters:
      hostId - Caller-generated UUID identifying this connection-owned listener.

  • Method Details

    • getHostId

      public String getHostId()
      Returns the hostId property.
      Returns:
      Caller-generated UUID identifying this connection-owned listener.

    • getLocalServer

      public HostLocalServerOptions getLocalServer()
      Returns the localServer property.
      Returns:
      Enables a local WebSocket listener.

    • getGitHubEnvironment

      public HostGitHubEnvironmentOptions getGitHubEnvironment()
      Returns the githubEnvironment property.
      Returns:
      Registers a GitHub Mission Control environment and enables its relay transport.

    • getSessionFactory

      public Boolean getSessionFactory()
      Returns the sessionFactory property.
      Returns:
      Ask the owning SDK application to materialize AHP sessions.

    • getResumeFactory

      public Boolean getResumeFactory()
      Returns the resumeFactory property.
      Returns:
      Ask the owning application to resume its durable AHP sessions.

    • getComputeId

      public String getComputeId()
      Returns the computeId property.
      Returns:
      Stable application identity selecting its durable host catalog. Defaults to the persisted runtime compute GUID; must agree with githubEnvironment.computeId when both are supplied.

    • setLocalServer

      public HostStartRequest setLocalServer(HostLocalServerOptions value)
      Sets the localServer property.
      Parameters:
      value - Enables a local WebSocket listener.
      Returns:
      this request

    • setGitHubEnvironment

      public HostStartRequest setGitHubEnvironment(HostGitHubEnvironmentOptions value)
      Sets the githubEnvironment property.
      Parameters:
      value - Registers a GitHub Mission Control environment and enables its relay transport.
      Returns:
      this request

    • setSessionFactory

      public HostStartRequest setSessionFactory(Boolean value)
      Sets the sessionFactory property.
      Parameters:
      value - Ask the owning SDK application to materialize AHP sessions.
      Returns:
      this request

    • setResumeFactory

      public HostStartRequest setResumeFactory(Boolean value)
      Sets the resumeFactory property.
      Parameters:
      value - Ask the owning application to resume its durable AHP sessions.
      Returns:
      this request

    • setComputeId

      public HostStartRequest setComputeId(String value)
      Sets the computeId property.
      Parameters:
      value - Stable application identity selecting its durable host catalog. Defaults to the persisted runtime compute GUID; must agree with githubEnvironment.computeId when both are supplied.
      Returns:
      this request