App Engine v1 API - Class InstanceName (2.2.0)

public sealed class InstanceName : IResourceName, IEquatable<InstanceName>

Reference documentation and code samples for the App Engine v1 API class InstanceName.

Resource name for the Instance resource.

Inheritance

object > InstanceName

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

InstanceName(string, string, string, string)

public InstanceName(string appId, string serviceId, string versionId, string instanceId)

Constructs a new instance of a InstanceName class from the component parts of pattern apps/{app}/services/{service}/versions/{version}/instances/{instance}

Parameters
NameDescription
appIdstring

The App ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

The App ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

InstanceId

public string InstanceId { get; }

The Instance ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

ServiceId

public string ServiceId { get; }

The Service ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public InstanceName.ResourceNameType Type { get; }

The InstanceName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
InstanceNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

VersionId

public string VersionId { get; }

The Version ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Methods

Format(string, string, string, string)

public static string Format(string appId, string serviceId, string versionId, string instanceId)

Formats the IDs into the string representation of this InstanceName with pattern apps/{app}/services/{service}/versions/{version}/instances/{instance}.

Parameters
NameDescription
appIdstring

The App ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InstanceName with pattern apps/{app}/services/{service}/versions/{version}/instances/{instance}.

FormatAppServiceVersionInstance(string, string, string, string)

public static string FormatAppServiceVersionInstance(string appId, string serviceId, string versionId, string instanceId)

Formats the IDs into the string representation of this InstanceName with pattern apps/{app}/services/{service}/versions/{version}/instances/{instance}.

Parameters
NameDescription
appIdstring

The App ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InstanceName with pattern apps/{app}/services/{service}/versions/{version}/instances/{instance}.

FromAppServiceVersionInstance(string, string, string, string)

public static InstanceName FromAppServiceVersionInstance(string appId, string serviceId, string versionId, string instanceId)

Creates a InstanceName with the pattern apps/{app}/services/{service}/versions/{version}/instances/{instance}.

Parameters
NameDescription
appIdstring

The App ID. Must not be null or empty.

serviceIdstring

The Service ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

Returns
TypeDescription
InstanceName

A new instance of InstanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
InstanceName

A new instance of InstanceName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static InstanceName Parse(string instanceName)

Parses the given resource name string into a new InstanceName instance.

Parameter
NameDescription
instanceNamestring

The resource name in string form. Must not be null.

Returns
TypeDescription
InstanceName

The parsed InstanceName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • apps/{app}/services/{service}/versions/{version}/instances/{instance}

Parse(string, bool)

public static InstanceName Parse(string instanceName, bool allowUnparsed)

Parses the given resource name string into a new InstanceName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
instanceNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
TypeDescription
InstanceName

The parsed InstanceName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • apps/{app}/services/{service}/versions/{version}/instances/{instance}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out InstanceName)

public static bool TryParse(string instanceName, out InstanceName result)

Tries to parse the given resource name string into a new InstanceName instance.

Parameters
NameDescription
instanceNamestring

The resource name in string form. Must not be null.

resultInstanceName

When this method returns, the parsed InstanceName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • apps/{app}/services/{service}/versions/{version}/instances/{instance}

TryParse(string, bool, out InstanceName)

public static bool TryParse(string instanceName, bool allowUnparsed, out InstanceName result)

Tries to parse the given resource name string into a new InstanceName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
instanceNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

resultInstanceName

When this method returns, the parsed InstanceName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • apps/{app}/services/{service}/versions/{version}/instances/{instance}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstanceName, InstanceName)

public static bool operator ==(InstanceName a, InstanceName b)

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aInstanceName

The first resource name to compare, or null.

bInstanceName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(InstanceName, InstanceName)

public static bool operator !=(InstanceName a, InstanceName b)

Determines whether two specified resource names have different values.

Parameters
NameDescription
aInstanceName

The first resource name to compare, or null.

bInstanceName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.