Identity and Access Management (IAM) v3beta API - Class AccessPolicyName (1.0.0-beta03)

1.0.0-beta03 (latest) 1.0.0-beta02

public sealed class AccessPolicyName : IResourceName, IEquatable<AccessPolicyName>

Reference documentation and code samples for the Identity and Access Management (IAM) v3beta API class AccessPolicyName.

Resource name for the AccessPolicy resource.

Inheritance

object > AccessPolicyName

Implements

IResourceName, IEquatableAccessPolicyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Constructors

AccessPolicyName(string, string, string)

public AccessPolicyName(string organizationId, string locationId, string accessPolicyId)

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

Parameters
Name	Description
organizationId	string The Organization ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
accessPolicyId	string The AccessPolicy ID. Must not be null or empty.

Properties

AccessPolicyId

public string AccessPolicyId { get; }

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

Property Value
Type	Description
string

FolderId

public string FolderId { get; }

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

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

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
string

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

Type

public AccessPolicyName.ResourceNameType Type { get; }

The AccessPolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
AccessPolicyNameResourceNameType

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

public static string Format(string organizationId, string locationId, string accessPolicyId)

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

Parameters
Name	Description
organizationId	string The Organization ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
accessPolicyId	string The AccessPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this AccessPolicyName with pattern organizations/{organization}/locations/{location}/accessPolicies/{access_policy}.

FormatFolderLocationAccessPolicy(string, string, string)

public static string FormatFolderLocationAccessPolicy(string folderId, string locationId, string accessPolicyId)

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

Parameters
Name	Description
folderId	string The Folder ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
accessPolicyId	string The AccessPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this AccessPolicyName with pattern folders/{folder}/locations/{location}/accessPolicies/{access_policy}.

FormatOrganizationLocationAccessPolicy(string, string, string)

public static string FormatOrganizationLocationAccessPolicy(string organizationId, string locationId, string accessPolicyId)

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

Parameters
Name	Description
organizationId	string The Organization ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
accessPolicyId	string The AccessPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this AccessPolicyName with pattern organizations/{organization}/locations/{location}/accessPolicies/{access_policy}.

FormatProjectLocationAccessPolicy(string, string, string)

public static string FormatProjectLocationAccessPolicy(string projectId, string locationId, string accessPolicyId)

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

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
accessPolicyId	string The AccessPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this AccessPolicyName with pattern projects/{project}/locations/{location}/accessPolicies/{access_policy}.

FromFolderLocationAccessPolicy(string, string, string)

public static AccessPolicyName FromFolderLocationAccessPolicy(string folderId, string locationId, string accessPolicyId)

Creates a AccessPolicyName with the pattern folders/{folder}/locations/{location}/accessPolicies/{access_policy}.

Parameters
Name	Description
folderId	string The Folder ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
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.

FromOrganizationLocationAccessPolicy(string, string, string)

public static AccessPolicyName FromOrganizationLocationAccessPolicy(string organizationId, string locationId, string accessPolicyId)

Creates a AccessPolicyName with the pattern organizations/{organization}/locations/{location}/accessPolicies/{access_policy}.

Parameters
Name	Description
organizationId	string The Organization ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
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.

FromProjectLocationAccessPolicy(string, string, string)

public static AccessPolicyName FromProjectLocationAccessPolicy(string projectId, string locationId, string accessPolicyId)

Creates a AccessPolicyName with the pattern projects/{project}/locations/{location}/accessPolicies/{access_policy}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
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
int

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:

• organizations/{organization}/locations/{location}/accessPolicies/{access_policy}
• folders/{folder}/locations/{location}/accessPolicies/{access_policy}
• projects/{project}/locations/{location}/accessPolicies/{access_policy}

Parse(string, bool)

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	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
AccessPolicyName	The parsed AccessPolicyName if successful.

Remarks

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

• organizations/{organization}/locations/{location}/accessPolicies/{access_policy}
• folders/{folder}/locations/{location}/accessPolicies/{access_policy}
• projects/{project}/locations/{location}/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
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}/locations/{location}/accessPolicies/{access_policy}
• folders/{folder}/locations/{location}/accessPolicies/{access_policy}
• projects/{project}/locations/{location}/accessPolicies/{access_policy}

TryParse(string, bool, 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	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	AccessPolicyName When this method returns, the parsed AccessPolicyName, 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}/locations/{location}/accessPolicies/{access_policy}
• folders/{folder}/locations/{location}/accessPolicies/{access_policy}
• projects/{project}/locations/{location}/accessPolicies/{access_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AccessPolicyName, AccessPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	AccessPolicyName The first resource name to compare, or null.
b	AccessPolicyName 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 !=(AccessPolicyName, AccessPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	AccessPolicyName The first resource name to compare, or null.
b	AccessPolicyName 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.