Class SpokeName

public sealed class SpokeName : IResourceName, IEquatable<SpokeName>

Resource name for the Spoke resource.

Inheritance

Object > SpokeName

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringspokeId

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

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

SpokeId

public string SpokeId { get; }

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

Property Value
TypeDescription
String

Type

public SpokeName.ResourceNameType Type { get; }

The SpokeName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SpokeName.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, 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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringspokeId

The Spoke ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringspokeId

The Spoke ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringspokeId

The Spoke ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SpokeName

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

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

Parameter
TypeNameDescription
StringspokeName

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

Returns
TypeDescription
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, Boolean)

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
TypeNameDescription
StringspokeName

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
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
TypeNameDescription
StringspokeName

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

SpokeNameresult

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

TryParse(String, Boolean, 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
TypeNameDescription
StringspokeName

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.

SpokeNameresult

When this method returns, the parsed SpokeName, 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/{location}/spokes/{spoke}
Or may be in any format if allowUnparsed is true.

Operators

Equality(SpokeName, SpokeName)

public static bool operator ==(SpokeName a, SpokeName b)
Parameters
TypeNameDescription
SpokeNamea
SpokeNameb
Returns
TypeDescription
Boolean

Inequality(SpokeName, SpokeName)

public static bool operator !=(SpokeName a, SpokeName b)
Parameters
TypeNameDescription
SpokeNamea
SpokeNameb
Returns
TypeDescription
Boolean