Identity Access Context Manager v1 API - Class AccessPolicyName (2.1.0)

public sealed class AccessPolicyName : IResourceName, IEquatable<AccessPolicyName>

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

Resource name for the AccessPolicy resource.

Inheritance

Object > AccessPolicyName

Implements

IResourceName, IEquatable<AccessPolicyName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Identity.AccessContextManager.V1

Assembly

Google.Identity.AccessContextManager.V1.dll

Constructors

AccessPolicyName(String)

public AccessPolicyName(string accessPolicyId)

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

Parameter
Name	Description
`accessPolicyId`	`String` The `AccessPolicy` ID. Must not be `null` or empty.

Properties

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 AccessPolicyName.ResourceNameType Type { get; }

The AccessPolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AccessPolicyName.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)

public static string Format(string accessPolicyId)

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

Parameter
Name	Description
`accessPolicyId`	`String` The `AccessPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this AccessPolicyName with pattern `accessPolicies/{access_policy}`.

FormatAccessPolicy(String)

public static string FormatAccessPolicy(string accessPolicyId)

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

Parameter
Name	Description
`accessPolicyId`	`String` The `AccessPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this AccessPolicyName with pattern `accessPolicies/{access_policy}`.

FromAccessPolicy(String)

public static AccessPolicyName FromAccessPolicy(string accessPolicyId)

Creates a AccessPolicyName with the pattern accessPolicies/{access_policy}.

Parameter
Name	Description
`accessPolicyId`	`String` The `AccessPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`AccessPolicyName`	A new instance of AccessPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AccessPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AccessPolicyName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AccessPolicyName`	A new instance of AccessPolicyName 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 AccessPolicyName Parse(string accessPolicyName)

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

Parameter
Name	Description
`accessPolicyName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AccessPolicyName`	The parsed AccessPolicyName if successful.

Remarks

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

accessPolicies/{access_policy}

Parse(String, Boolean)

public static AccessPolicyName Parse(string accessPolicyName, bool allowUnparsed)

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

Parameters
Name	Description
`accessPolicyName`	`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
`AccessPolicyName`	The parsed AccessPolicyName if successful.

Remarks

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

accessPolicies/{access_policy}

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

public static bool TryParse(string accessPolicyName, out AccessPolicyName result)

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

Parameters
Name	Description
`accessPolicyName`	`String` The resource name in string form. Must not be `null`.
`result`	`AccessPolicyName` When this method returns, the parsed AccessPolicyName, 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}

TryParse(String, Boolean, out AccessPolicyName)

public static bool TryParse(string accessPolicyName, bool allowUnparsed, out AccessPolicyName result)

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

Parameters
Name	Description
`accessPolicyName`	`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`	`AccessPolicyName` When this method returns, the parsed AccessPolicyName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AccessPolicyName, AccessPolicyName)

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

Parameters
Name	Description
`a`	`AccessPolicyName`
`b`	`AccessPolicyName`

Returns
Type	Description
`Boolean`

Inequality(AccessPolicyName, AccessPolicyName)

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

Parameters
Name	Description
`a`	`AccessPolicyName`
`b`	`AccessPolicyName`

Returns
Type	Description
`Boolean`