Design Center v1 API - Class RoleName (1.0.0-beta01) 

public sealed class RoleName : IResourceName, IEquatable<RoleName>

Reference documentation and code samples for the Design Center v1 API class RoleName.

Resource name for the Role resource.

Inheritance

object > RoleName

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

RoleName(string, string)

public RoleName(string organizationId, string roleId)

Constructs a new instance of a RoleName class from the component parts of pattern organizations/{organization}/roles/{role}

Parameters
Name Description
organizationId string

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

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

RoleId

public string RoleId { get; }

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

Property Value
Type Description
string

Type

public RoleName.ResourceNameType Type { get; }

The RoleName.ResourceNameType of the contained resource name.

Property Value
Type Description
RoleNameResourceNameType

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 organizationId, string roleId)

Formats the IDs into the string representation of this RoleName with pattern organizations/{organization}/roles/{role}.

Parameters
Name Description
organizationId string

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

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

The string representation of this RoleName with pattern organizations/{organization}/roles/{role}.

FormatOrganizationRole(string, string)

public static string FormatOrganizationRole(string organizationId, string roleId)

Formats the IDs into the string representation of this RoleName with pattern organizations/{organization}/roles/{role}.

Parameters
Name Description
organizationId string

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

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

The string representation of this RoleName with pattern organizations/{organization}/roles/{role}.

FormatProjectRole(string, string)

public static string FormatProjectRole(string projectId, string roleId)

Formats the IDs into the string representation of this RoleName with pattern projects/{project}/roles/{role}.

Parameters
Name Description
projectId string

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

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

The string representation of this RoleName with pattern projects/{project}/roles/{role} .

FormatRole(string)

public static string FormatRole(string roleId)

Formats the IDs into the string representation of this RoleName with pattern roles/{role} .

Parameter
Name Description
roleId string

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

The string representation of this RoleName with pattern roles/{role}.

FromOrganizationRole(string, string)

public static RoleName FromOrganizationRole(string organizationId, string roleId)

Creates a RoleName with the pattern organizations/{organization}/roles/{role}.

Parameters
Name Description
organizationId string

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

The Role ID. Must not be null or empty.
Returns
Type Description
RoleName

A new instance of RoleName constructed from the provided ids.

FromProjectRole(string, string)

public static RoleName FromProjectRole(string projectId, string roleId)

Creates a RoleName with the pattern projects/{project}/roles/{role}.

Parameters
Name Description
projectId string

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

The Role ID. Must not be null or empty.
Returns
Type Description
RoleName

A new instance of RoleName constructed from the provided ids.

FromRole(string)

public static RoleName FromRole(string roleId)

Creates a RoleName with the pattern roles/{role}.

Parameter
Name Description
roleId string

The Role ID. Must not be null or empty.
Returns
Type Description
RoleName

A new instance of RoleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RoleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RoleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
roleName string

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

The parsed RoleName if successful.
Remarks

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

  • organizations/{organization}/roles/{role}
  • projects/{project}/roles/{role}
  • roles/{role}

Parse(string, bool)

public static RoleName Parse(string roleName, bool allowUnparsed)

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

Parameters
Name Description
roleName 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
RoleName

The parsed RoleName if successful.
Remarks

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

  • organizations/{organization}/roles/{role}
  • projects/{project}/roles/{role}
  • roles/{role}

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

public static bool TryParse(string roleName, out RoleName result)

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

Parameters
Name Description
roleName string

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

When this method returns, the parsed RoleName, 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:

  • organizations/{organization}/roles/{role}
  • projects/{project}/roles/{role}
  • roles/{role}

TryParse(string, bool, out RoleName)

public static bool TryParse(string roleName, bool allowUnparsed, out RoleName result)

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

Parameters
Name Description
roleName 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 RoleName

When this method returns, the parsed RoleName, 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:

  • organizations/{organization}/roles/{role}
  • projects/{project}/roles/{role}
  • roles/{role}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RoleName, RoleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RoleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RoleName

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

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.