Google Cloud reCAPTCHA Enterprise v1 API - Class RelatedAccountGroupName (2.4.0)

public sealed class RelatedAccountGroupName : IResourceName, IEquatable<RelatedAccountGroupName>

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class RelatedAccountGroupName.

Resource name for the RelatedAccountGroup resource.

Inheritance

object > RelatedAccountGroupName

Namespace

GoogleGoogle.CloudGoogle.Cloud.RecaptchaEnterpriseV1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

RelatedAccountGroupName(string, string)

public RelatedAccountGroupName(string projectId, string relatedaccountgroupId)

Constructs a new instance of a RelatedAccountGroupName class from the component parts of pattern projects/{project}/relatedaccountgroups/{relatedaccountgroup}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

relatedaccountgroupIdstring

The Relatedaccountgroup 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
bool

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

RelatedaccountgroupId

public string RelatedaccountgroupId { get; }

The Relatedaccountgroup ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public RelatedAccountGroupName.ResourceNameType Type { get; }

The RelatedAccountGroupName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RelatedAccountGroupNameResourceNameType

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

Formats the IDs into the string representation of this RelatedAccountGroupName with pattern projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

relatedaccountgroupIdstring

The Relatedaccountgroup ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RelatedAccountGroupName with pattern projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

FormatProjectRelatedaccountgroup(string, string)

public static string FormatProjectRelatedaccountgroup(string projectId, string relatedaccountgroupId)

Formats the IDs into the string representation of this RelatedAccountGroupName with pattern projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

relatedaccountgroupIdstring

The Relatedaccountgroup ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RelatedAccountGroupName with pattern projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

FromProjectRelatedaccountgroup(string, string)

public static RelatedAccountGroupName FromProjectRelatedaccountgroup(string projectId, string relatedaccountgroupId)

Creates a RelatedAccountGroupName with the pattern projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

relatedaccountgroupIdstring

The Relatedaccountgroup ID. Must not be null or empty.

Returns
TypeDescription
RelatedAccountGroupName

A new instance of RelatedAccountGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RelatedAccountGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RelatedAccountGroupName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RelatedAccountGroupName

A new instance of RelatedAccountGroupName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static RelatedAccountGroupName Parse(string relatedAccountGroupName)

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

Parameter
NameDescription
relatedAccountGroupNamestring

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

Returns
TypeDescription
RelatedAccountGroupName

The parsed RelatedAccountGroupName if successful.

Remarks

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

  • projects/{project}/relatedaccountgroups/{relatedaccountgroup}

Parse(string, bool)

public static RelatedAccountGroupName Parse(string relatedAccountGroupName, bool allowUnparsed)

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

Parameters
NameDescription
relatedAccountGroupNamestring

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

allowUnparsedbool

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
RelatedAccountGroupName

The parsed RelatedAccountGroupName if successful.

Remarks

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

  • projects/{project}/relatedaccountgroups/{relatedaccountgroup}
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 RelatedAccountGroupName)

public static bool TryParse(string relatedAccountGroupName, out RelatedAccountGroupName result)

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

Parameters
NameDescription
relatedAccountGroupNamestring

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

resultRelatedAccountGroupName

When this method returns, the parsed RelatedAccountGroupName, or null if parsing failed.

Returns
TypeDescription
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}/relatedaccountgroups/{relatedaccountgroup}

TryParse(string, bool, out RelatedAccountGroupName)

public static bool TryParse(string relatedAccountGroupName, bool allowUnparsed, out RelatedAccountGroupName result)

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

Parameters
NameDescription
relatedAccountGroupNamestring

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

allowUnparsedbool

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.

resultRelatedAccountGroupName

When this method returns, the parsed RelatedAccountGroupName, or null if parsing failed.

Returns
TypeDescription
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}/relatedaccountgroups/{relatedaccountgroup}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RelatedAccountGroupName, RelatedAccountGroupName)

public static bool operator ==(RelatedAccountGroupName a, RelatedAccountGroupName b)
Parameters
NameDescription
aRelatedAccountGroupName
bRelatedAccountGroupName
Returns
TypeDescription
bool

operator !=(RelatedAccountGroupName, RelatedAccountGroupName)

public static bool operator !=(RelatedAccountGroupName a, RelatedAccountGroupName b)
Parameters
NameDescription
aRelatedAccountGroupName
bRelatedAccountGroupName
Returns
TypeDescription
bool