Google Cloud Monitoring v3 API - Class GroupName (3.15.0) 

public sealed class GroupName : IResourceName, IEquatable<GroupName>

Reference documentation and code samples for the Google Cloud Monitoring v3 API class GroupName.

Resource name for the Group resource.

Inheritance

object > GroupName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

GroupName(string, string)

public GroupName(string projectId, string groupId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

GroupId

public string GroupId { get; }

The Group ID. May be null, depending on which resource name is contained by this instance.

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

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public GroupName.ResourceNameType Type { get; }

The GroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
GroupNameResourceNameType

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

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
string

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

FormatFolderGroup(string, string)

public static string FormatFolderGroup(string folderId, string groupId)

Formats the IDs into the string representation of this GroupName with pattern folders/{folder}/groups/{group}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this GroupName with pattern folders/{folder}/groups/{group} .

FormatOrganizationGroup(string, string)

public static string FormatOrganizationGroup(string organizationId, string groupId)

Formats the IDs into the string representation of this GroupName with pattern organizations/{organization}/groups/{group}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this GroupName with pattern organizations/{organization}/groups/{group}.

FormatProjectGroup(string, string)

public static string FormatProjectGroup(string projectId, string groupId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
string

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

FromFolderGroup(string, string)

public static GroupName FromFolderGroup(string folderId, string groupId)

Creates a GroupName with the pattern folders/{folder}/groups/{group}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
GroupName

A new instance of GroupName constructed from the provided ids.

FromOrganizationGroup(string, string)

public static GroupName FromOrganizationGroup(string organizationId, string groupId)

Creates a GroupName with the pattern organizations/{organization}/groups/{group}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
GroupName

A new instance of GroupName constructed from the provided ids.

FromProjectGroup(string, string)

public static GroupName FromProjectGroup(string projectId, string groupId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
groupId string

The Group ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
GroupName

A new instance of GroupName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static GroupName Parse(string groupName)

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

Parameter
Name Description
groupName string

The resource name in string form. Must not be null.
Returns
Type Description
GroupName

The parsed GroupName if successful.
Remarks

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

  • projects/{project}/groups/{group}
  • organizations/{organization}/groups/{group}
  • folders/{folder}/groups/{group}

Parse(string, bool)

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
Name Description
groupName 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
GroupName

The parsed GroupName if successful.
Remarks

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

  • projects/{project}/groups/{group}
  • organizations/{organization}/groups/{group}
  • folders/{folder}/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
Type Description
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
Name Description
groupName string

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

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

TryParse(string, bool, 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
Name Description
groupName 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 GroupName

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

Operators

operator ==(GroupName, GroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GroupName

The first resource name to compare, or null.
b GroupName

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 !=(GroupName, GroupName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GroupName

The first resource name to compare, or null.
b GroupName

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.