Google Cloud PHP shared dependency, providing functionality useful to all components. Client - Class Metadata (1.59.1)

Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class Metadata.

A library for accessing the Google Compute Engine (GCE) metadata.

The metadata is available from Google Compute Engine instances and App Engine Managed VMs instances.

Example:

use Google\Cloud\Core\Compute\Metadata;

$metadata = new Metadata();
$projectId = $metadata->getProjectId();
// It is easy to get any metadata from a project.
$val = $metadata->getProjectMetadata($key);

Namespace

Google \ Cloud \ Core \ Compute

Methods

__construct

Parameter
Name Description
reader Google\Cloud\Core\Compute\Metadata\Readers\ReaderInterface

[optional] A metadata reader implementation.

setReader

Replace the default reader implementation

Parameter
Name Description
reader Google\Cloud\Core\Compute\Metadata\Readers\ReaderInterface

The reader implementation

get

Fetch a metadata item by its path

Example:

$projectId = $metadata->get('project/project-id');
Parameter
Name Description
path string

The path of the item to retrieve.

getProjectId

Detect and return the project ID

Example:

$projectId = $metadata->getProjectId();
Returns
Type Description
string

getNumericProjectId

Detect and return the numeric project ID

Example:

$projectId = $metadata->getNumericProjectId();
Returns
Type Description
string

getProjectMetadata

Fetch an item from the project metadata

Example:

$foo = $metadata->getProjectMetadata('foo');
Parameter
Name Description
key string

The metadata key

Returns
Type Description
string

getInstanceMetadata

Fetch an item from the instance metadata

Example:

$foo = $metadata->getInstanceMetadata('foo');
Parameter
Name Description
key string

The instance metadata key

Returns
Type Description
string