Network Connectivity v1 API - Class HubName (2.6.0)

Version 2.6.0

• 2.8.0 (latest)
• 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.2.0
• 1.1.0
• 1.0.0

public sealed class HubName : IResourceName, IEquatable<HubName>

Reference documentation and code samples for the Network Connectivity v1 API class HubName.

Resource name for the Hub resource.

Inheritance

object > HubName

Implements

IResourceName, IEquatableHubName

Inherited Members

object.GetType()

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

HubName(string, string)

public HubName(string projectId, string hubId)

Constructs a new instance of a HubName class from the component parts of pattern projects/{project}/locations/global/hubs/{hub}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
hubId	string The Hub ID. Must not be null or empty.

Properties

HubId

public string HubId { get; }

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

Property Value
Type	Description
string

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

Type

public HubName.ResourceNameType Type { get; }

The HubName.ResourceNameType of the contained resource name.

Property Value
Type	Description
HubNameResourceNameType

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

Formats the IDs into the string representation of this HubName with pattern projects/{project}/locations/global/hubs/{hub}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
hubId	string The Hub ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this HubName with pattern projects/{project}/locations/global/hubs/{hub}.

FormatProjectHub(string, string)

public static string FormatProjectHub(string projectId, string hubId)

Formats the IDs into the string representation of this HubName with pattern projects/{project}/locations/global/hubs/{hub}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
hubId	string The Hub ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this HubName with pattern projects/{project}/locations/global/hubs/{hub}.

FromProjectHub(string, string)

public static HubName FromProjectHub(string projectId, string hubId)

Creates a HubName with the pattern projects/{project}/locations/global/hubs/{hub}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
hubId	string The Hub ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static HubName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HubName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
HubName	The parsed HubName if successful.

Remarks

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

• projects/{project}/locations/global/hubs/{hub}

Parse(string, bool)

public static HubName Parse(string hubName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/global/hubs/{hub}

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

public static bool TryParse(string hubName, out HubName result)

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

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

TryParse(string, bool, out HubName)

public static bool TryParse(string hubName, bool allowUnparsed, out HubName result)

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

Parameters
Name	Description
hubName	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	HubName When this method returns, the parsed HubName, 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/hubs/{hub}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HubName, HubName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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