Network Connectivity v1alpha1 API - Class SpokeName (2.0.0-alpha02)

Version 2.0.0-alpha02

• 2.0.0-alpha04 (latest)
• 2.0.0-alpha03
• 1.0.0-alpha03

public sealed class SpokeName : IResourceName, IEquatable<SpokeName>

Reference documentation and code samples for the Network Connectivity v1alpha1 API class SpokeName.

Resource name for the Spoke resource.

Inheritance

object > SpokeName

Implements

IResourceName, IEquatableSpokeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.NetworkConnectivity.V1Alpha1

Assembly

Google.Cloud.NetworkConnectivity.V1Alpha1.dll

Constructors

SpokeName(string, string, string)

public SpokeName(string projectId, string locationId, string spokeId)

Constructs a new instance of a SpokeName class from the component parts of pattern projects/{project}/locations/{location}/spokes/{spoke}

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.
spokeId	string The Spoke 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

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

SpokeId

public string SpokeId { get; }

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

Property Value
Type	Description
string

Type

public SpokeName.ResourceNameType Type { get; }

The SpokeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SpokeNameResourceNameType

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 spokeId)

Formats the IDs into the string representation of this SpokeName with pattern projects/{project}/locations/{location}/spokes/{spoke}.

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.
spokeId	string The Spoke ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SpokeName with pattern projects/{project}/locations/{location}/spokes/{spoke}.

FormatProjectLocationSpoke(string, string, string)

public static string FormatProjectLocationSpoke(string projectId, string locationId, string spokeId)

Formats the IDs into the string representation of this SpokeName with pattern projects/{project}/locations/{location}/spokes/{spoke}.

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.
spokeId	string The Spoke ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SpokeName with pattern projects/{project}/locations/{location}/spokes/{spoke}.

FromProjectLocationSpoke(string, string, string)

public static SpokeName FromProjectLocationSpoke(string projectId, string locationId, string spokeId)

Creates a SpokeName with the pattern projects/{project}/locations/{location}/spokes/{spoke} .

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.
spokeId	string The Spoke ID. Must not be null or empty.

Returns
Type	Description
SpokeName	A new instance of SpokeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SpokeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SpokeName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
SpokeName	A new instance of SpokeName 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 SpokeName Parse(string spokeName)

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

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

Returns
Type	Description
SpokeName	The parsed SpokeName if successful.

Remarks

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

• projects/{project}/locations/{location}/spokes/{spoke}

Parse(string, bool)

public static SpokeName Parse(string spokeName, bool allowUnparsed)

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

Parameters
Name	Description
spokeName	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
SpokeName	The parsed SpokeName if successful.

Remarks

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

• projects/{project}/locations/{location}/spokes/{spoke}

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 SpokeName)

public static bool TryParse(string spokeName, out SpokeName result)

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

Parameters
Name	Description
spokeName	string The resource name in string form. Must not be null.
result	SpokeName When this method returns, the parsed SpokeName, 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}/spokes/{spoke}

TryParse(string, bool, out SpokeName)

public static bool TryParse(string spokeName, bool allowUnparsed, out SpokeName result)

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

Parameters
Name	Description
spokeName	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	SpokeName When this method returns, the parsed SpokeName, 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}/spokes/{spoke}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SpokeName, SpokeName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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