Documentation

WorkerDeploymentVersion
in package
implements Stringable uses CloneWith

Represents the version of a specific worker deployment.

Tags
see
WorkerDeploymentVersion
since

SDK 2.16.0

since

RoadRunner 2025.1.3

Table of Contents

Interfaces

Stringable

Properties

$buildId  : string
Identifies the Worker Deployment this Version is part of.
$deploymentName  : string
A unique identifier for this Version within the Deployment it is a part of.

Methods

__toString()  : non-empty-string
fromString()  : self
Build a worker deployment version from a canonical string representation.
new()  : self
Create a new worker deployment version with the given deployment name and build ID.
__construct()  : mixed

Properties

$deploymentName read-only

A unique identifier for this Version within the Deployment it is a part of.

public string $deploymentName

Not necessarily unique within the namespace. The combination of $deployment_name and $buildId uniquely identifies this Version within the namespace, because Deployment names are unique within a namespace.

Methods

__toString()

public __toString() : non-empty-string
Return values
non-empty-string

canonical string representation of this worker deployment version.

fromString()

Build a worker deployment version from a canonical string representation.

public static fromString(non-empty-string $canonicalString) : self
Parameters
$canonicalString : non-empty-string

The canonical string representation of the worker deployment version, formatted as "deploymentName.buildId". Deployment name must not have a "." in it.

Tags
throws
InvalidArgumentException

if the input string is not in the expected format.

Return values
self

new()

Create a new worker deployment version with the given deployment name and build ID.

public static new(non-empty-string $deploymentName, non-empty-string $buildId) : self
Parameters
$deploymentName : non-empty-string

The name of the worker deployment. Must not contain a ".".

$buildId : non-empty-string

The build ID of the worker deployment.

Tags
throws
InvalidArgumentException

if the deployment name or build ID is empty or invalid.

Return values
self

__construct()

private __construct(string $deploymentName, string $buildId) : mixed
Parameters
$deploymentName : string
$buildId : string

        
On this page

Search results