Class ErrorGroupName (3.0.0-beta01)

public sealed class ErrorGroupName : IResourceName, IEquatable<ErrorGroupName>

Resource name for the ErrorGroup resource.

Inheritance

Object > ErrorGroupName

Namespace

Google.Cloud.ErrorReporting.V1Beta1

Assembly

Google.Cloud.ErrorReporting.V1Beta1.dll

Constructors

ErrorGroupName(String, String)

public ErrorGroupName(string projectId, string groupId)

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

Parameters
NameDescription
projectIdString

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

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 ErrorGroupName.ResourceNameType Type { get; }

The ErrorGroupName.ResourceNameType of the contained resource name.

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

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

Parameters
NameDescription
projectIdString

The Project 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 ErrorGroupName with pattern projects/{project}/groups/{group}.

FormatProjectGroup(String, String)

public static string FormatProjectGroup(string projectId, string groupId)

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

Parameters
NameDescription
projectIdString

The Project 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 ErrorGroupName with pattern projects/{project}/groups/{group}.

FromProjectGroup(String, String)

public static ErrorGroupName FromProjectGroup(string projectId, string groupId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

groupIdString

The Group ID. Must not be null or empty.

Returns
TypeDescription
ErrorGroupName

A new instance of ErrorGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ErrorGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ErrorGroupName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ErrorGroupName

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

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

Parameter
NameDescription
errorGroupNameString

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

Returns
TypeDescription
ErrorGroupName

The parsed ErrorGroupName if successful.

Remarks

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

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

Parse(String, Boolean)

public static ErrorGroupName Parse(string errorGroupName, bool allowUnparsed)

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

Parameters
NameDescription
errorGroupNameString

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
ErrorGroupName

The parsed ErrorGroupName if successful.

Remarks

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

  • projects/{project}/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 ErrorGroupName)

public static bool TryParse(string errorGroupName, out ErrorGroupName result)

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

Parameters
NameDescription
errorGroupNameString

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

resultErrorGroupName

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

TryParse(String, Boolean, out ErrorGroupName)

public static bool TryParse(string errorGroupName, bool allowUnparsed, out ErrorGroupName result)

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

Parameters
NameDescription
errorGroupNameString

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.

resultErrorGroupName

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

Operators

Equality(ErrorGroupName, ErrorGroupName)

public static bool operator ==(ErrorGroupName a, ErrorGroupName b)
Parameters
NameDescription
aErrorGroupName
bErrorGroupName
Returns
TypeDescription
Boolean

Inequality(ErrorGroupName, ErrorGroupName)

public static bool operator !=(ErrorGroupName a, ErrorGroupName b)
Parameters
NameDescription
aErrorGroupName
bErrorGroupName
Returns
TypeDescription
Boolean