Identity and Access Management (IAM) v3beta API - Class PrincipalAccessBoundaryPolicyName (1.0.0-beta01) 

public sealed class PrincipalAccessBoundaryPolicyName : IResourceName, IEquatable<PrincipalAccessBoundaryPolicyName>

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

Resource name for the PrincipalAccessBoundaryPolicy resource.

Inheritance

object > PrincipalAccessBoundaryPolicyName

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Constructors

PrincipalAccessBoundaryPolicyName(string, string, string)

public PrincipalAccessBoundaryPolicyName(string organizationId, string locationId, string principalAccessBoundaryPolicyId)

Constructs a new instance of a PrincipalAccessBoundaryPolicyName class from the component parts of pattern organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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.
principalAccessBoundaryPolicyId string

The PrincipalAccessBoundaryPolicy ID. Must not be null or empty.

Properties

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

PrincipalAccessBoundaryPolicyId

public string PrincipalAccessBoundaryPolicyId { get; }

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

Property Value
Type Description
string

Type

public PrincipalAccessBoundaryPolicyName.ResourceNameType Type { get; }

The PrincipalAccessBoundaryPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
PrincipalAccessBoundaryPolicyNameResourceNameType

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

Formats the IDs into the string representation of this PrincipalAccessBoundaryPolicyName with pattern organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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.
principalAccessBoundaryPolicyId string

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

The string representation of this PrincipalAccessBoundaryPolicyName with pattern organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy} .

FormatOrganizationLocationPrincipalAccessBoundaryPolicy(string, string, string)

public static string FormatOrganizationLocationPrincipalAccessBoundaryPolicy(string organizationId, string locationId, string principalAccessBoundaryPolicyId)

Formats the IDs into the string representation of this PrincipalAccessBoundaryPolicyName with pattern organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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.
principalAccessBoundaryPolicyId string

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

The string representation of this PrincipalAccessBoundaryPolicyName with pattern organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy} .

FromOrganizationLocationPrincipalAccessBoundaryPolicy(string, string, string)

public static PrincipalAccessBoundaryPolicyName FromOrganizationLocationPrincipalAccessBoundaryPolicy(string organizationId, string locationId, string principalAccessBoundaryPolicyId)

Creates a PrincipalAccessBoundaryPolicyName with the pattern organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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.
principalAccessBoundaryPolicyId string

The PrincipalAccessBoundaryPolicy ID. Must not be null or empty.
Returns
Type Description
PrincipalAccessBoundaryPolicyName

A new instance of PrincipalAccessBoundaryPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PrincipalAccessBoundaryPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PrincipalAccessBoundaryPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
principalAccessBoundaryPolicyName string

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

The parsed PrincipalAccessBoundaryPolicyName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy}

Parse(string, bool)

public static PrincipalAccessBoundaryPolicyName Parse(string principalAccessBoundaryPolicyName, bool allowUnparsed)

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

Parameters
Name Description
principalAccessBoundaryPolicyName 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
PrincipalAccessBoundaryPolicyName

The parsed PrincipalAccessBoundaryPolicyName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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

TryParse(string, out PrincipalAccessBoundaryPolicyName)

public static bool TryParse(string principalAccessBoundaryPolicyName, out PrincipalAccessBoundaryPolicyName result)

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

Parameters
Name Description
principalAccessBoundaryPolicyName string

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

When this method returns, the parsed PrincipalAccessBoundaryPolicyName, 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}/principalAccessBoundaryPolicies/{principal_access_boundary_policy}

TryParse(string, bool, out PrincipalAccessBoundaryPolicyName)

public static bool TryParse(string principalAccessBoundaryPolicyName, bool allowUnparsed, out PrincipalAccessBoundaryPolicyName result)

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

Parameters
Name Description
principalAccessBoundaryPolicyName 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 PrincipalAccessBoundaryPolicyName

When this method returns, the parsed PrincipalAccessBoundaryPolicyName, 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}/principalAccessBoundaryPolicies/{principal_access_boundary_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PrincipalAccessBoundaryPolicyName, PrincipalAccessBoundaryPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PrincipalAccessBoundaryPolicyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PrincipalAccessBoundaryPolicyName

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

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.