Identity Access Context Manager v1 API - Class AccessLevelName (2.3.0) 

public sealed class AccessLevelName : IResourceName, IEquatable<AccessLevelName>

Reference documentation and code samples for the Identity Access Context Manager v1 API class AccessLevelName.

Resource name for the AccessLevel resource.

Inheritance

object > AccessLevelName

Namespace

Google.Identity.AccessContextManager.V1

Assembly

Google.Identity.AccessContextManager.V1.dll

Constructors

AccessLevelName(string, string)

public AccessLevelName(string accessPolicyId, string accessLevelId)

Constructs a new instance of a AccessLevelName class from the component parts of pattern accessPolicies/{access_policy}/accessLevels/{access_level}

Parameters
Name Description
accessPolicyId string

The AccessPolicy ID. Must not be null or empty.
accessLevelId string

The AccessLevel ID. Must not be null or empty.

Properties

AccessLevelId

public string AccessLevelId { get; }

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

Property Value
Type Description
string

AccessPolicyId

public string AccessPolicyId { get; }

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

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

Type

public AccessLevelName.ResourceNameType Type { get; }

The AccessLevelName.ResourceNameType of the contained resource name.

Property Value
Type Description
AccessLevelNameResourceNameType

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 accessPolicyId, string accessLevelId)

Formats the IDs into the string representation of this AccessLevelName with pattern accessPolicies/{access_policy}/accessLevels/{access_level}.

Parameters
Name Description
accessPolicyId string

The AccessPolicy ID. Must not be null or empty.
accessLevelId string

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

The string representation of this AccessLevelName with pattern accessPolicies/{access_policy}/accessLevels/{access_level}.

FormatAccessPolicyAccessLevel(string, string)

public static string FormatAccessPolicyAccessLevel(string accessPolicyId, string accessLevelId)

Formats the IDs into the string representation of this AccessLevelName with pattern accessPolicies/{access_policy}/accessLevels/{access_level}.

Parameters
Name Description
accessPolicyId string

The AccessPolicy ID. Must not be null or empty.
accessLevelId string

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

The string representation of this AccessLevelName with pattern accessPolicies/{access_policy}/accessLevels/{access_level}.

FromAccessPolicyAccessLevel(string, string)

public static AccessLevelName FromAccessPolicyAccessLevel(string accessPolicyId, string accessLevelId)

Creates a AccessLevelName with the pattern accessPolicies/{access_policy}/accessLevels/{access_level}.

Parameters
Name Description
accessPolicyId string

The AccessPolicy ID. Must not be null or empty.
accessLevelId string

The AccessLevel ID. Must not be null or empty.
Returns
Type Description
AccessLevelName

A new instance of AccessLevelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AccessLevelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AccessLevelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
accessLevelName string

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

The parsed AccessLevelName if successful.
Remarks

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

  • accessPolicies/{access_policy}/accessLevels/{access_level}

Parse(string, bool)

public static AccessLevelName Parse(string accessLevelName, bool allowUnparsed)

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

Parameters
Name Description
accessLevelName 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
AccessLevelName

The parsed AccessLevelName if successful.
Remarks

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

  • accessPolicies/{access_policy}/accessLevels/{access_level}
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 AccessLevelName)

public static bool TryParse(string accessLevelName, out AccessLevelName result)

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

Parameters
Name Description
accessLevelName string

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

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

  • accessPolicies/{access_policy}/accessLevels/{access_level}

TryParse(string, bool, out AccessLevelName)

public static bool TryParse(string accessLevelName, bool allowUnparsed, out AccessLevelName result)

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

Parameters
Name Description
accessLevelName 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 AccessLevelName

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

  • accessPolicies/{access_policy}/accessLevels/{access_level}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AccessLevelName, AccessLevelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AccessLevelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AccessLevelName

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

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.