Record Class ShellCredentials

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.ShellCredentials
@CopilotExperimental @Generated("copilot-sdk-codegen") public record ShellCredentials(Boolean git, Boolean gh) extends Record
Command-scoped GitHub credential injection for the shell commands an agent runs. Each channel is opt-in and independent, and injection is scoped to the individual command spawn: the credential is resolved from the session's *current* authentication at every spawn and reaches only spawns whose script actually invokes `git` or `gh`. Because nothing is retained between spawns, replacing the session credential (`session.gitHubAuth.setCredentials`) changes what the next spawned command presents — which seeding a credential into the runtime process's own environment cannot do, since a child's environment is fixed at `exec`. The credential is matched to the host it authenticates to, so a github.com credential is never presented to a GitHub Enterprise host and vice versa. Where a channel cannot express that boundary it injects nothing rather than crossing it -- see `gh` below. This is independent of `sandboxConfig`: it is a decision about which identity the agent presents, not about what the agent may touch, and it works on every platform whether or not an OS sandboxing backend is available. `sandboxConfig.auth` remains the sandbox-scoped spelling and is additive with this one.
Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShellCredentials(Boolean git, Boolean gh)
    Creates an instance of a ShellCredentials record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Boolean
    gh()
    Returns the value of the gh record component.
    Boolean
    git()
    Returns the value of the git record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ShellCredentials

      public ShellCredentials(Boolean git, Boolean gh)
      Creates an instance of a ShellCredentials record class.
      Parameters:
      git - the value for the git record component
      gh - the value for the gh record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • git

      public Boolean git()
      Returns the value of the git record component.
      Returns:
      the value of the git record component

    • gh

      public Boolean gh()
      Returns the value of the gh record component.
      Returns:
      the value of the gh record component