Network Management v1 API - Class ConnectivityTestName (2.17.0)

Version latest

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class ConnectivityTestName : IResourceName, IEquatable<ConnectivityTestName>

Reference documentation and code samples for the Network Management v1 API class ConnectivityTestName.

Resource name for the ConnectivityTest resource.

Inheritance

object > ConnectivityTestName

Implements

IResourceName, IEquatableConnectivityTestName

Inherited Members

object.GetType()

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
Name	Description
projectId	string The Project ID. Must not be null or empty.
testId	string 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
Type	Description
bool

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

TestId

public string TestId { get; }

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

Property Value
Type	Description
string

Type

public ConnectivityTestName.ResourceNameType Type { get; }

The ConnectivityTestName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ConnectivityTestNameResourceNameType

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)

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
Name	Description
projectId	string The Project ID. Must not be null or empty.
testId	string The Test ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
testId	string The Test ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	string The Project ID. Must not be null or empty.
testId	string The Test ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ConnectivityTestName	A new instance of ConnectivityTestName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ConnectivityTestName Parse(string connectivityTestName)

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

Parameter
Name	Description
connectivityTestName	string The resource name in string form. Must not be null.

Returns
Type	Description
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, bool)

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
Name	Description
connectivityTestName	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
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
Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
connectivityTestName	string The resource name in string form. Must not be null.
result	ConnectivityTestName When this method returns, the parsed ConnectivityTestName, 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/global/connectivityTests/{test}

TryParse(string, bool, 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
Name	Description
connectivityTestName	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	ConnectivityTestName When this method returns, the parsed ConnectivityTestName, 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/global/connectivityTests/{test}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConnectivityTestName, ConnectivityTestName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ConnectivityTestName The first resource name to compare, or null.
b	ConnectivityTestName 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 !=(ConnectivityTestName, ConnectivityTestName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ConnectivityTestName The first resource name to compare, or null.
b	ConnectivityTestName 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.