Class GcePlatformDetails (4.4.0)

public sealed class GcePlatformDetails

Google Compute Engine details.

Inheritance

object > GcePlatformDetails

Google.Api.Gax.dll

public GcePlatformDetails(string metadataJson, string projectId, string instanceId, string zoneName)

Construct details of Google Compute Engine

Parameters
Name	Description
`metadataJson`	`string` The full JSON string retrieved from the metadata server. Must not be `null`.
`projectId`	`string` The project ID. Must not be `null`.
`instanceId`	`string` The instance ID. Must not be `null`.
`zoneName`	`string` The zone name. Must not be `null`. If this value is in the format `projects/<project-number>/zones/<zone-name>` then Location will return the `<zone-name>` part of this value. If not, Location will throw InvalidOperationException. If this value has been retrived from Google Compute Engine, the it's format will be the one described above.

public string InstanceId { get; }

The Instance ID of the GCE instance on which this is running. This is never null.

Property Value
Type	Description
`string`

public string Location { get; }

The zone name where this GCE instance is running. If ZoneName is in the format

projects/<project-number>/zones/<zone-name>

this value will be the

<zone-name>

part in ZoneName. If ZoneName is in a different format then this getting the value of this property will throw InvalidOperationException.

Property Value
Type	Description
`string`

public string MetadataJson { get; }

The full JSON string retrieved from the metadata server. This is never null.

Property Value
Type	Description
`string`

public string ProjectId { get; }

The Project ID under which this GCE instance is running. This is never null.

Property Value
Type	Description
`string`

public string ZoneName { get; }

The zone where this GCE instance is running. This is never null. This will be in the format

projects/<project-number>/zones/<zone-name>

id the value has been retrieved from Google Compute Engine.

Property Value
Type	Description
`string`

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

public static GcePlatformDetails TryLoad(string metadataJson)

Builds a GcePlatformDetails from the given metadata. This metadata is normally retrieved from the GCE metadata server.

Parameter
Name	Description
`metadataJson`	`string` JSON metadata, normally retrieved from the GCE metadata server. Must not be `null`.

Returns
Type	Description
`GcePlatformDetails`	A populated GcePlatformDetails if the metadata represents and GCE instance; `null` otherwise.