Network Services v1 API - Class MeshName (1.0.0-beta01)

public sealed class MeshName : IResourceName, IEquatable<MeshName>

Reference documentation and code samples for the Network Services v1 API class MeshName.

Resource name for the Mesh resource.

Inheritance

object > MeshName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

MeshName(string, string, string)

public MeshName(string projectId, string locationId, string meshId)

Constructs a new instance of a MeshName class from the component parts of pattern projects/{project}/locations/{location}/meshes/{mesh}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
meshId string

The Mesh ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

MeshId

public string MeshId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public MeshName.ResourceNameType Type { get; }

The MeshName.ResourceNameType of the contained resource name.

Property Value
Type Description
MeshNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string meshId)

Formats the IDs into the string representation of this MeshName with pattern projects/{project}/locations/{location}/meshes/{mesh}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
meshId string

The Mesh ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MeshName with pattern projects/{project}/locations/{location}/meshes/{mesh}.

FormatProjectLocationMesh(string, string, string)

public static string FormatProjectLocationMesh(string projectId, string locationId, string meshId)

Formats the IDs into the string representation of this MeshName with pattern projects/{project}/locations/{location}/meshes/{mesh}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
meshId string

The Mesh ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MeshName with pattern projects/{project}/locations/{location}/meshes/{mesh}.

FromProjectLocationMesh(string, string, string)

public static MeshName FromProjectLocationMesh(string projectId, string locationId, string meshId)

Creates a MeshName with the pattern projects/{project}/locations/{location}/meshes/{mesh} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
meshId string

The Mesh ID. Must not be null or empty.
Returns
Type Description
MeshName

A new instance of MeshName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MeshName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MeshName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
MeshName

A new instance of MeshName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static MeshName Parse(string meshName)

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

Parameter
Name Description
meshName string

The resource name in string form. Must not be null.
Returns
Type Description
MeshName

The parsed MeshName if successful.
Remarks

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

  • projects/{project}/locations/{location}/meshes/{mesh}

Parse(string, bool)

public static MeshName Parse(string meshName, bool allowUnparsed)

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

Parameters
Name Description
meshName string

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

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
Type Description
MeshName

The parsed MeshName if successful.
Remarks

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

  • projects/{project}/locations/{location}/meshes/{mesh}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out MeshName)

public static bool TryParse(string meshName, out MeshName result)

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

Parameters
Name Description
meshName string

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

When this method returns, the parsed MeshName, or null if parsing failed.
Returns
Type Description
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:

  • projects/{project}/locations/{location}/meshes/{mesh}

TryParse(string, bool, out MeshName)

public static bool TryParse(string meshName, bool allowUnparsed, out MeshName result)

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

Parameters
Name Description
meshName string

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

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.
result MeshName

When this method returns, the parsed MeshName, or null if parsing failed.
Returns
Type Description
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:

  • projects/{project}/locations/{location}/meshes/{mesh}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MeshName, MeshName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MeshName

The first resource name to compare, or null.
b MeshName

The second resource name to compare, or null.
Returns
Type Description
bool

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

operator !=(MeshName, MeshName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MeshName

The first resource name to compare, or null.
b MeshName

The second resource name to compare, or null.
Returns
Type Description
bool

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