Class GroupName

public sealed class GroupName : IResourceName, IEquatable<GroupName>

Resource name for the Group resource.

Inheritance

Object > GroupName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

GroupName(String, String, String)

public GroupName(string projectId, string locationId, string groupId)

Constructs a new instance of a GroupName class from the component parts of pattern projects/{project}/locations/{location}/groups/{group}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

groupIdString

The Group ID. Must not be null or empty.

Properties

GroupId

public string GroupId { get; }

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

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

Type

public GroupName.ResourceNameType Type { get; }

The GroupName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
GroupName.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 groupId)

Formats the IDs into the string representation of this GroupName with pattern projects/{project}/locations/{location}/groups/{group}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

groupIdString

The Group ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this GroupName with pattern projects/{project}/locations/{location}/groups/{group}.

FormatProjectLocationGroup(String, String, String)

public static string FormatProjectLocationGroup(string projectId, string locationId, string groupId)

Formats the IDs into the string representation of this GroupName with pattern projects/{project}/locations/{location}/groups/{group}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

groupIdString

The Group ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this GroupName with pattern projects/{project}/locations/{location}/groups/{group}.

FromProjectLocationGroup(String, String, String)

public static GroupName FromProjectLocationGroup(string projectId, string locationId, string groupId)

Creates a GroupName with the pattern projects/{project}/locations/{location}/groups/{group} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

groupIdString

The Group ID. Must not be null or empty.

Returns
TypeDescription
GroupName

A new instance of GroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GroupName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
GroupName

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

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

Parameter
NameDescription
groupNameString

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

Returns
TypeDescription
GroupName

The parsed GroupName if successful.

Remarks

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

  • projects/{project}/locations/{location}/groups/{group}

Parse(String, Boolean)

public static GroupName Parse(string groupName, bool allowUnparsed)

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

Parameters
NameDescription
groupNameString

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

allowUnparsedBoolean

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
GroupName

The parsed GroupName if successful.

Remarks

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

  • projects/{project}/locations/{location}/groups/{group}
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 GroupName)

public static bool TryParse(string groupName, out GroupName result)

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

Parameters
NameDescription
groupNameString

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

resultGroupName

When this method returns, the parsed GroupName, 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}/groups/{group}

TryParse(String, Boolean, out GroupName)

public static bool TryParse(string groupName, bool allowUnparsed, out GroupName result)

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

Parameters
NameDescription
groupNameString

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

allowUnparsedBoolean

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.

resultGroupName

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

Operators

Equality(GroupName, GroupName)

public static bool operator ==(GroupName a, GroupName b)
Parameters
NameDescription
aGroupName
bGroupName
Returns
TypeDescription
Boolean

Inequality(GroupName, GroupName)

public static bool operator !=(GroupName a, GroupName b)
Parameters
NameDescription
aGroupName
bGroupName
Returns
TypeDescription
Boolean