Class HubName

public sealed class HubName : IResourceName, IEquatable<HubName>

Resource name for the Hub resource.

Inheritance

Object > HubName

Namespace

Google.Cloud.NetworkConnectivity.V1Alpha1

Assembly

Google.Cloud.NetworkConnectivity.V1Alpha1.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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringhubId

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

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

Type

public HubName.ResourceNameType Type { get; }

The HubName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
HubName.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 hubId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringhubId

The Hub ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

StringhubId

The Hub ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

StringhubId

The Hub ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
HubName

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

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

Parameter
TypeNameDescription
StringhubName

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

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

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

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

The string representation of the resource name.

Overrides

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

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

HubNameresult

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

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

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.

HubNameresult

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

Operators

Equality(HubName, HubName)

public static bool operator ==(HubName a, HubName b)
Parameters
TypeNameDescription
HubNamea
HubNameb
Returns
TypeDescription
Boolean

Inequality(HubName, HubName)

public static bool operator !=(HubName a, HubName b)
Parameters
TypeNameDescription
HubNamea
HubNameb
Returns
TypeDescription
Boolean