Identity Access Context Manager v1 API - Class AccessLevelName (2.1.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
NameDescription
accessPolicyIdString

The AccessPolicy ID. Must not be null or empty.

accessLevelIdString

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
TypeDescription
String

AccessPolicyId

public string AccessPolicyId { get; }

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

Type

public AccessLevelName.ResourceNameType Type { get; }

The AccessLevelName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AccessLevelName.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 accessPolicyId, string accessLevelId)

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

Parameters
NameDescription
accessPolicyIdString

The AccessPolicy ID. Must not be null or empty.

accessLevelIdString

The AccessLevel ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
accessPolicyIdString

The AccessPolicy ID. Must not be null or empty.

accessLevelIdString

The AccessLevel ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
accessPolicyIdString

The AccessPolicy ID. Must not be null or empty.

accessLevelIdString

The AccessLevel ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AccessLevelName

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

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

Parameter
NameDescription
accessLevelNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
accessLevelNameString

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
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
TypeDescription
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
NameDescription
accessLevelNameString

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

resultAccessLevelName

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

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

TryParse(String, Boolean, 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
NameDescription
accessLevelNameString

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.

resultAccessLevelName

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

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

Operators

Equality(AccessLevelName, AccessLevelName)

public static bool operator ==(AccessLevelName a, AccessLevelName b)
Parameters
NameDescription
aAccessLevelName
bAccessLevelName
Returns
TypeDescription
Boolean

Inequality(AccessLevelName, AccessLevelName)

public static bool operator !=(AccessLevelName a, AccessLevelName b)
Parameters
NameDescription
aAccessLevelName
bAccessLevelName
Returns
TypeDescription
Boolean