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

Implements

IResourceName, IEquatable<AccessLevelName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

Type

public AccessLevelName.ResourceNameType Type { get; }

The AccessLevelName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AccessLevelName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, 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
Name	Description
`accessLevelName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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

Object.ToString()

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
`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
Name	Description
`accessLevelName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`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
Name	Description
`a`	`AccessLevelName`
`b`	`AccessLevelName`

Returns
Type	Description
`Boolean`

Inequality(AccessLevelName, AccessLevelName)

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

Parameters
Name	Description
`a`	`AccessLevelName`
`b`	`AccessLevelName`

Returns
Type	Description
`Boolean`