Class ConnectivityTestName

public sealed class ConnectivityTestName : IResourceName, IEquatable<ConnectivityTestName>

Resource name for the ConnectivityTest resource.

Inheritance

Object > ConnectivityTestName

Namespace

Google.Cloud.NetworkManagement.V1

Assembly

Google.Cloud.NetworkManagement.V1.dll

Constructors

ConnectivityTestName(String, String)

public ConnectivityTestName(string projectId, string testId)

Constructs a new instance of a ConnectivityTestName class from the component parts of pattern projects/{project}/locations/global/connectivityTests/{test}

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtestId

The Test 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
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

TestId

public string TestId { get; }

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

Property Value
TypeDescription
String

Type

public ConnectivityTestName.ResourceNameType Type { get; }

The ConnectivityTestName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConnectivityTestName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String)

public static string Format(string projectId, string testId)

Formats the IDs into the string representation of this ConnectivityTestName with pattern projects/{project}/locations/global/connectivityTests/{test}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtestId

The Test ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ConnectivityTestName with pattern projects/{project}/locations/global/connectivityTests/{test}.

FormatProjectTest(String, String)

public static string FormatProjectTest(string projectId, string testId)

Formats the IDs into the string representation of this ConnectivityTestName with pattern projects/{project}/locations/global/connectivityTests/{test}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtestId

The Test ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ConnectivityTestName with pattern projects/{project}/locations/global/connectivityTests/{test}.

FromProjectTest(String, String)

public static ConnectivityTestName FromProjectTest(string projectId, string testId)

Creates a ConnectivityTestName with the pattern projects/{project}/locations/global/connectivityTests/{test}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtestId

The Test ID. Must not be null or empty.

Returns
TypeDescription
ConnectivityTestName

A new instance of ConnectivityTestName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectivityTestName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectivityTestName containing an unparsed resource name.

Parameter
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConnectivityTestName

A new instance of ConnectivityTestName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ConnectivityTestName Parse(string connectivityTestName)

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

Parameter
TypeNameDescription
StringconnectivityTestName

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

Returns
TypeDescription
ConnectivityTestName

The parsed ConnectivityTestName if successful.

Remarks

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

  • projects/{project}/locations/global/connectivityTests/{test}

Parse(String, Boolean)

public static ConnectivityTestName Parse(string connectivityTestName, bool allowUnparsed)

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

Parameters
TypeNameDescription
StringconnectivityTestName

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

BooleanallowUnparsed

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
ConnectivityTestName

The parsed ConnectivityTestName if successful.

Remarks

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

  • projects/{project}/locations/global/connectivityTests/{test}
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 ConnectivityTestName)

public static bool TryParse(string connectivityTestName, out ConnectivityTestName result)

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

Parameters
TypeNameDescription
StringconnectivityTestName

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

ConnectivityTestNameresult

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

Returns
TypeDescription
Boolean

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/global/connectivityTests/{test}

TryParse(String, Boolean, out ConnectivityTestName)

public static bool TryParse(string connectivityTestName, bool allowUnparsed, out ConnectivityTestName result)

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

Parameters
TypeNameDescription
StringconnectivityTestName

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

BooleanallowUnparsed

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.

ConnectivityTestNameresult

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

Returns
TypeDescription
Boolean

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/global/connectivityTests/{test}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ConnectivityTestName, ConnectivityTestName)

public static bool operator ==(ConnectivityTestName a, ConnectivityTestName b)
Parameters
TypeNameDescription
ConnectivityTestNamea
ConnectivityTestNameb
Returns
TypeDescription
Boolean

Inequality(ConnectivityTestName, ConnectivityTestName)

public static bool operator !=(ConnectivityTestName a, ConnectivityTestName b)
Parameters
TypeNameDescription
ConnectivityTestNamea
ConnectivityTestNameb
Returns
TypeDescription
Boolean