Class MembershipName

public sealed class MembershipName : IResourceName, IEquatable<MembershipName>

Resource name for the Membership resource.

Inheritance

Object > MembershipName

Namespace

Google.Cloud.GkeHub.V1Beta1

Assembly

Google.Cloud.GkeHub.V1Beta1.dll

Constructors

MembershipName(String, String, String)

public MembershipName(string projectId, string locationId, string membershipId)

Constructs a new instance of a MembershipName class from the component parts of pattern projects/{project}/locations/{location}/memberships/{membership}

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringmembershipId

The Membership 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

MembershipId

public string MembershipId { get; }

The Membership 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

Type

public MembershipName.ResourceNameType Type { get; }

The MembershipName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MembershipName.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 membershipId)

Formats the IDs into the string representation of this MembershipName with pattern projects/{project}/locations/{location}/memberships/{membership}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringmembershipId

The Membership ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this MembershipName with pattern projects/{project}/locations/{location}/memberships/{membership}.

FormatProjectLocationMembership(String, String, String)

public static string FormatProjectLocationMembership(string projectId, string locationId, string membershipId)

Formats the IDs into the string representation of this MembershipName with pattern projects/{project}/locations/{location}/memberships/{membership}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringmembershipId

The Membership ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this MembershipName with pattern projects/{project}/locations/{location}/memberships/{membership}.

FromProjectLocationMembership(String, String, String)

public static MembershipName FromProjectLocationMembership(string projectId, string locationId, string membershipId)

Creates a MembershipName with the pattern projects/{project}/locations/{location}/memberships/{membership}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringmembershipId

The Membership ID. Must not be null or empty.

Returns
TypeDescription
MembershipName

A new instance of MembershipName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MembershipName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MembershipName containing an unparsed resource name.

Parameter
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
MembershipName

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

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

Parameter
TypeNameDescription
StringmembershipName

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

Returns
TypeDescription
MembershipName

The parsed MembershipName if successful.

Remarks

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

  • projects/{project}/locations/{location}/memberships/{membership}

Parse(String, Boolean)

public static MembershipName Parse(string membershipName, bool allowUnparsed)

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

Parameters
TypeNameDescription
StringmembershipName

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
MembershipName

The parsed MembershipName if successful.

Remarks

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

  • projects/{project}/locations/{location}/memberships/{membership}
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 MembershipName)

public static bool TryParse(string membershipName, out MembershipName result)

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

Parameters
TypeNameDescription
StringmembershipName

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

MembershipNameresult

When this method returns, the parsed MembershipName, 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}/memberships/{membership}

TryParse(String, Boolean, out MembershipName)

public static bool TryParse(string membershipName, bool allowUnparsed, out MembershipName result)

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

Parameters
TypeNameDescription
StringmembershipName

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.

MembershipNameresult

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

Operators

Equality(MembershipName, MembershipName)

public static bool operator ==(MembershipName a, MembershipName b)
Parameters
TypeNameDescription
MembershipNamea
MembershipNameb
Returns
TypeDescription
Boolean

Inequality(MembershipName, MembershipName)

public static bool operator !=(MembershipName a, MembershipName b)
Parameters
TypeNameDescription
MembershipNamea
MembershipNameb
Returns
TypeDescription
Boolean