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

public sealed class PolicyBindingName : IResourceName, IEquatable<PolicyBindingName>

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

Resource name for the PolicyBinding resource.

Inheritance

object > PolicyBindingName

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Constructors

PolicyBindingName(string, string, string)

public PolicyBindingName(string organizationId, string locationId, string policyBindingId)

Constructs a new instance of a PolicyBindingName class from the component parts of pattern organizations/{organization}/locations/{location}/policyBindings/{policy_binding}

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.
policyBindingId string

The PolicyBinding ID. Must not be null or empty.

Properties

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

PolicyBindingId

public string PolicyBindingId { get; }

The PolicyBinding 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 PolicyBindingName.ResourceNameType Type { get; }

The PolicyBindingName.ResourceNameType of the contained resource name.

Property Value
Type Description
PolicyBindingNameResourceNameType

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

Formats the IDs into the string representation of this PolicyBindingName with pattern organizations/{organization}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

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

The string representation of this PolicyBindingName with pattern organizations/{organization}/locations/{location}/policyBindings/{policy_binding}.

FormatFolderLocationPolicyBinding(string, string, string)

public static string FormatFolderLocationPolicyBinding(string folderId, string locationId, string policyBindingId)

Formats the IDs into the string representation of this PolicyBindingName with pattern folders/{folder}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

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

The string representation of this PolicyBindingName with pattern folders/{folder}/locations/{location}/policyBindings/{policy_binding}.

FormatOrganizationLocationPolicyBinding(string, string, string)

public static string FormatOrganizationLocationPolicyBinding(string organizationId, string locationId, string policyBindingId)

Formats the IDs into the string representation of this PolicyBindingName with pattern organizations/{organization}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

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

The string representation of this PolicyBindingName with pattern organizations/{organization}/locations/{location}/policyBindings/{policy_binding}.

FormatProjectLocationPolicyBinding(string, string, string)

public static string FormatProjectLocationPolicyBinding(string projectId, string locationId, string policyBindingId)

Formats the IDs into the string representation of this PolicyBindingName with pattern projects/{project}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

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

The string representation of this PolicyBindingName with pattern projects/{project}/locations/{location}/policyBindings/{policy_binding}.

FromFolderLocationPolicyBinding(string, string, string)

public static PolicyBindingName FromFolderLocationPolicyBinding(string folderId, string locationId, string policyBindingId)

Creates a PolicyBindingName with the pattern folders/{folder}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

The PolicyBinding ID. Must not be null or empty.
Returns
Type Description
PolicyBindingName

A new instance of PolicyBindingName constructed from the provided ids.

FromOrganizationLocationPolicyBinding(string, string, string)

public static PolicyBindingName FromOrganizationLocationPolicyBinding(string organizationId, string locationId, string policyBindingId)

Creates a PolicyBindingName with the pattern organizations/{organization}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

The PolicyBinding ID. Must not be null or empty.
Returns
Type Description
PolicyBindingName

A new instance of PolicyBindingName constructed from the provided ids.

FromProjectLocationPolicyBinding(string, string, string)

public static PolicyBindingName FromProjectLocationPolicyBinding(string projectId, string locationId, string policyBindingId)

Creates a PolicyBindingName with the pattern projects/{project}/locations/{location}/policyBindings/{policy_binding}.

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.
policyBindingId string

The PolicyBinding ID. Must not be null or empty.
Returns
Type Description
PolicyBindingName

A new instance of PolicyBindingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PolicyBindingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PolicyBindingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
policyBindingName string

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

The parsed PolicyBindingName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/policyBindings/{policy_binding}
  • folders/{folder}/locations/{location}/policyBindings/{policy_binding}
  • projects/{project}/locations/{location}/policyBindings/{policy_binding}

Parse(string, bool)

public static PolicyBindingName Parse(string policyBindingName, bool allowUnparsed)

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

Parameters
Name Description
policyBindingName 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
PolicyBindingName

The parsed PolicyBindingName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/policyBindings/{policy_binding}
  • folders/{folder}/locations/{location}/policyBindings/{policy_binding}
  • projects/{project}/locations/{location}/policyBindings/{policy_binding}
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 PolicyBindingName)

public static bool TryParse(string policyBindingName, out PolicyBindingName result)

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

Parameters
Name Description
policyBindingName string

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

When this method returns, the parsed PolicyBindingName, 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}/policyBindings/{policy_binding}
  • folders/{folder}/locations/{location}/policyBindings/{policy_binding}
  • projects/{project}/locations/{location}/policyBindings/{policy_binding}

TryParse(string, bool, out PolicyBindingName)

public static bool TryParse(string policyBindingName, bool allowUnparsed, out PolicyBindingName result)

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

Parameters
Name Description
policyBindingName 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 PolicyBindingName

When this method returns, the parsed PolicyBindingName, 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}/policyBindings/{policy_binding}
  • folders/{folder}/locations/{location}/policyBindings/{policy_binding}
  • projects/{project}/locations/{location}/policyBindings/{policy_binding}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PolicyBindingName, PolicyBindingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PolicyBindingName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PolicyBindingName

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

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.